yellowgrid-api-ts 3.2.77-dev.0 → 3.2.77
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +239 -257
- package/.openapi-generator/VERSION +1 -1
- package/README.md +8 -38
- package/api.ts +552 -6719
- package/base.ts +2 -26
- package/common.ts +16 -39
- package/config.json +3 -3
- package/configuration.ts +25 -19
- package/dist/api.d.ts +243 -5742
- package/dist/api.js +510 -2068
- package/dist/base.d.ts +1 -25
- package/dist/base.js +2 -21
- package/dist/common.d.ts +5 -36
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/PortStatusEnum.d.ts +5 -0
- package/dist/models/PortStatusEnum.js +5 -0
- package/docs/AccountsApi.md +1 -1
- package/docs/AdminNumberPortDTO.md +4 -0
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +61 -6
- package/docs/OAuth20Api.md +4 -4
- package/docs/OrdersApi.md +47 -945
- package/docs/{PostAddOrderNoteRequest.md → PostAddAdminNoteRequest.md} +4 -4
- package/docs/PricingApi.md +1 -1
- package/docs/ProductsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +57 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentItemEntity.md +1 -1
- package/docs/ShippingApi.md +1 -1
- package/docs/SmsAccountDTO.md +31 -0
- package/docs/SmsAccountRequestDTO.md +29 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/models/PortStatusEnum.ts +5 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/dist/models/CourierEnum.d.ts +0 -18
- package/dist/models/CourierEnum.js +0 -20
- package/dist/models/PrinterEnum.d.ts +0 -18
- package/dist/models/PrinterEnum.js +0 -20
- package/docs/BatchDTO.md +0 -59
- package/docs/CreditNoteDTO.md +0 -21
- package/docs/CreditNoteEntity.md +0 -29
- package/docs/CreditNoteItemDTO.md +0 -25
- package/docs/CreditNoteItemEntity.md +0 -29
- package/docs/CreditNoteModel.md +0 -29
- package/docs/NumberPortModel.md +0 -51
- package/docs/OrderDetailsDTO.md +0 -63
- package/docs/OrderItemDTO.md +0 -55
- package/docs/OrderedItemModel.md +0 -47
- package/docs/PostSplitOrderRequest.md +0 -20
- package/docs/PrinterEntity.md +0 -29
- package/docs/PutAllocateItemsRequest.md +0 -20
- package/docs/PutAllocateItemsRequestItemsInner.md +0 -22
- package/docs/ShipmentDTO.md +0 -35
- package/docs/ShipmentItemDTO.md +0 -23
- package/docs/ShipmentItemModel.md +0 -29
- package/docs/ShipmentModel.md +0 -43
- package/docs/ShipmentRequestDTO.md +0 -31
- package/docs/ShippingRequestDTO.md +0 -24
- package/docs/SupplierItemModel.md +0 -35
- package/docs/SupplierModel.md +0 -37
- package/docs/TelephonySupportTicketModel.md +0 -41
- package/hs_err_pid16044.log +0 -249
- package/hs_err_pid44560.log +0 -249
- package/hs_err_pid53988.log +0 -249
- package/hs_err_pid58728.log +0 -40
- package/models/CourierEnum.ts +0 -19
- package/models/PrinterEnum.ts +0 -19
package/docs/OrdersApi.md
CHANGED
|
@@ -1,89 +1,17 @@
|
|
|
1
1
|
# OrdersApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
|
|
8
7
|
|[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
|
|
9
|
-
|[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
|
|
10
8
|
|[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
|
|
11
|
-
|[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
|
|
12
9
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
13
|
-
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
14
10
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
15
|
-
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
16
11
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
17
|
-
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
18
|
-
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
19
12
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
20
|
-
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
21
|
-
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
22
|
-
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
23
|
-
|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
|
|
24
|
-
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
25
|
-
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
26
|
-
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
27
13
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
28
14
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
29
|
-
|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
|
|
30
|
-
|
|
31
|
-
# **deleteDeleteBatch**
|
|
32
|
-
> deleteDeleteBatch()
|
|
33
|
-
|
|
34
|
-
Delete Batch (Admin)
|
|
35
|
-
|
|
36
|
-
### Example
|
|
37
|
-
|
|
38
|
-
```typescript
|
|
39
|
-
import {
|
|
40
|
-
OrdersApi,
|
|
41
|
-
Configuration
|
|
42
|
-
} from 'yellowgrid-api-ts';
|
|
43
|
-
|
|
44
|
-
const configuration = new Configuration();
|
|
45
|
-
const apiInstance = new OrdersApi(configuration);
|
|
46
|
-
|
|
47
|
-
let id: number; //Order ID (default to undefined)
|
|
48
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
49
|
-
|
|
50
|
-
const { status, data } = await apiInstance.deleteDeleteBatch(
|
|
51
|
-
id,
|
|
52
|
-
batchId
|
|
53
|
-
);
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### Parameters
|
|
57
|
-
|
|
58
|
-
|Name | Type | Description | Notes|
|
|
59
|
-
|------------- | ------------- | ------------- | -------------|
|
|
60
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
61
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
### Return type
|
|
65
|
-
|
|
66
|
-
void (empty response body)
|
|
67
|
-
|
|
68
|
-
### Authorization
|
|
69
|
-
|
|
70
|
-
No authorization required
|
|
71
|
-
|
|
72
|
-
### HTTP request headers
|
|
73
|
-
|
|
74
|
-
- **Content-Type**: Not defined
|
|
75
|
-
- **Accept**: Not defined
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
### HTTP response details
|
|
79
|
-
| Status code | Description | Response headers |
|
|
80
|
-
|-------------|-------------|------------------|
|
|
81
|
-
|**200** | No Response | - |
|
|
82
|
-
|**400** | Bad Request | - |
|
|
83
|
-
|**401** | Unauthorised | - |
|
|
84
|
-
|**403** | Access Denied | - |
|
|
85
|
-
|
|
86
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
87
15
|
|
|
88
16
|
# **deleteUpdateOrder**
|
|
89
17
|
> deleteUpdateOrder()
|
|
@@ -115,66 +43,6 @@ const { status, data } = await apiInstance.deleteUpdateOrder(
|
|
|
115
43
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
116
44
|
|
|
117
45
|
|
|
118
|
-
### Return type
|
|
119
|
-
|
|
120
|
-
void (empty response body)
|
|
121
|
-
|
|
122
|
-
### Authorization
|
|
123
|
-
|
|
124
|
-
No authorization required
|
|
125
|
-
|
|
126
|
-
### HTTP request headers
|
|
127
|
-
|
|
128
|
-
- **Content-Type**: Not defined
|
|
129
|
-
- **Accept**: Not defined
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
### HTTP response details
|
|
133
|
-
| Status code | Description | Response headers |
|
|
134
|
-
|-------------|-------------|------------------|
|
|
135
|
-
|**200** | No Response | - |
|
|
136
|
-
|**400** | Bad Request | - |
|
|
137
|
-
|**401** | Unauthorised | - |
|
|
138
|
-
|**403** | Access Denied | - |
|
|
139
|
-
|
|
140
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
141
|
-
|
|
142
|
-
# **deleteUpdateShipment**
|
|
143
|
-
> deleteUpdateShipment()
|
|
144
|
-
|
|
145
|
-
Delete Shipment (Admin)
|
|
146
|
-
|
|
147
|
-
### Example
|
|
148
|
-
|
|
149
|
-
```typescript
|
|
150
|
-
import {
|
|
151
|
-
OrdersApi,
|
|
152
|
-
Configuration
|
|
153
|
-
} from 'yellowgrid-api-ts';
|
|
154
|
-
|
|
155
|
-
const configuration = new Configuration();
|
|
156
|
-
const apiInstance = new OrdersApi(configuration);
|
|
157
|
-
|
|
158
|
-
let id: number; //Order ID (default to undefined)
|
|
159
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
160
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
161
|
-
|
|
162
|
-
const { status, data } = await apiInstance.deleteUpdateShipment(
|
|
163
|
-
id,
|
|
164
|
-
batchId,
|
|
165
|
-
shipmentId
|
|
166
|
-
);
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
### Parameters
|
|
170
|
-
|
|
171
|
-
|Name | Type | Description | Notes|
|
|
172
|
-
|------------- | ------------- | ------------- | -------------|
|
|
173
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
174
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
175
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
176
|
-
|
|
177
|
-
|
|
178
46
|
### Return type
|
|
179
47
|
|
|
180
48
|
void (empty response body)
|
|
@@ -253,60 +121,6 @@ No authorization required
|
|
|
253
121
|
|
|
254
122
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
255
123
|
|
|
256
|
-
# **getGetAdminOrderDetails**
|
|
257
|
-
> OrderDetailsDTO getGetAdminOrderDetails()
|
|
258
|
-
|
|
259
|
-
Get Order Details (Admin)
|
|
260
|
-
|
|
261
|
-
### Example
|
|
262
|
-
|
|
263
|
-
```typescript
|
|
264
|
-
import {
|
|
265
|
-
OrdersApi,
|
|
266
|
-
Configuration
|
|
267
|
-
} from 'yellowgrid-api-ts';
|
|
268
|
-
|
|
269
|
-
const configuration = new Configuration();
|
|
270
|
-
const apiInstance = new OrdersApi(configuration);
|
|
271
|
-
|
|
272
|
-
let id: number; //Order ID (default to undefined)
|
|
273
|
-
|
|
274
|
-
const { status, data } = await apiInstance.getGetAdminOrderDetails(
|
|
275
|
-
id
|
|
276
|
-
);
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
### Parameters
|
|
280
|
-
|
|
281
|
-
|Name | Type | Description | Notes|
|
|
282
|
-
|------------- | ------------- | ------------- | -------------|
|
|
283
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
### Return type
|
|
287
|
-
|
|
288
|
-
**OrderDetailsDTO**
|
|
289
|
-
|
|
290
|
-
### Authorization
|
|
291
|
-
|
|
292
|
-
No authorization required
|
|
293
|
-
|
|
294
|
-
### HTTP request headers
|
|
295
|
-
|
|
296
|
-
- **Content-Type**: Not defined
|
|
297
|
-
- **Accept**: application/json
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
### HTTP response details
|
|
301
|
-
| Status code | Description | Response headers |
|
|
302
|
-
|-------------|-------------|------------------|
|
|
303
|
-
|**200** | Order Details | - |
|
|
304
|
-
|**400** | Bad Request | - |
|
|
305
|
-
|**401** | Unauthorised | - |
|
|
306
|
-
|**403** | Access Denied | - |
|
|
307
|
-
|
|
308
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
309
|
-
|
|
310
124
|
# **getGetEditableOrder**
|
|
311
125
|
> DetailedOrderRequestDTO getGetEditableOrder()
|
|
312
126
|
|
|
@@ -361,60 +175,6 @@ No authorization required
|
|
|
361
175
|
|
|
362
176
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
363
177
|
|
|
364
|
-
# **getGetOrderPdf**
|
|
365
|
-
> File getGetOrderPdf()
|
|
366
|
-
|
|
367
|
-
Download Order PDF
|
|
368
|
-
|
|
369
|
-
### Example
|
|
370
|
-
|
|
371
|
-
```typescript
|
|
372
|
-
import {
|
|
373
|
-
OrdersApi,
|
|
374
|
-
Configuration
|
|
375
|
-
} from 'yellowgrid-api-ts';
|
|
376
|
-
|
|
377
|
-
const configuration = new Configuration();
|
|
378
|
-
const apiInstance = new OrdersApi(configuration);
|
|
379
|
-
|
|
380
|
-
let id: number; //Order ID (default to undefined)
|
|
381
|
-
|
|
382
|
-
const { status, data } = await apiInstance.getGetOrderPdf(
|
|
383
|
-
id
|
|
384
|
-
);
|
|
385
|
-
```
|
|
386
|
-
|
|
387
|
-
### Parameters
|
|
388
|
-
|
|
389
|
-
|Name | Type | Description | Notes|
|
|
390
|
-
|------------- | ------------- | ------------- | -------------|
|
|
391
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
### Return type
|
|
395
|
-
|
|
396
|
-
**File**
|
|
397
|
-
|
|
398
|
-
### Authorization
|
|
399
|
-
|
|
400
|
-
No authorization required
|
|
401
|
-
|
|
402
|
-
### HTTP request headers
|
|
403
|
-
|
|
404
|
-
- **Content-Type**: Not defined
|
|
405
|
-
- **Accept**: application/pdf
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
### HTTP response details
|
|
409
|
-
| Status code | Description | Response headers |
|
|
410
|
-
|-------------|-------------|------------------|
|
|
411
|
-
|**200** | Order PDF | - |
|
|
412
|
-
|**400** | Bad Request | - |
|
|
413
|
-
|**401** | Unauthorised | - |
|
|
414
|
-
|**403** | Access Denied | - |
|
|
415
|
-
|
|
416
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
417
|
-
|
|
418
178
|
# **getGetOrders**
|
|
419
179
|
> OrderSummariesModel getGetOrders()
|
|
420
180
|
|
|
@@ -487,10 +247,10 @@ No authorization required
|
|
|
487
247
|
|
|
488
248
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
489
249
|
|
|
490
|
-
# **
|
|
491
|
-
>
|
|
250
|
+
# **postCreateAdminOrder**
|
|
251
|
+
> Array<OrderSummaryDTO> postCreateAdminOrder()
|
|
492
252
|
|
|
493
|
-
|
|
253
|
+
Create An Order (Admin)
|
|
494
254
|
|
|
495
255
|
### Example
|
|
496
256
|
|
|
@@ -498,18 +258,18 @@ Add Order Note
|
|
|
498
258
|
import {
|
|
499
259
|
OrdersApi,
|
|
500
260
|
Configuration,
|
|
501
|
-
|
|
261
|
+
AdminOrderRequestDTO
|
|
502
262
|
} from 'yellowgrid-api-ts';
|
|
503
263
|
|
|
504
264
|
const configuration = new Configuration();
|
|
505
265
|
const apiInstance = new OrdersApi(configuration);
|
|
506
266
|
|
|
507
|
-
let
|
|
508
|
-
let
|
|
267
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
268
|
+
let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
|
|
509
269
|
|
|
510
|
-
const { status, data } = await apiInstance.
|
|
511
|
-
|
|
512
|
-
|
|
270
|
+
const { status, data } = await apiInstance.postCreateAdminOrder(
|
|
271
|
+
readonly,
|
|
272
|
+
adminOrderRequestDTO
|
|
513
273
|
);
|
|
514
274
|
```
|
|
515
275
|
|
|
@@ -517,13 +277,13 @@ const { status, data } = await apiInstance.postAddOrderNote(
|
|
|
517
277
|
|
|
518
278
|
|Name | Type | Description | Notes|
|
|
519
279
|
|------------- | ------------- | ------------- | -------------|
|
|
520
|
-
| **
|
|
521
|
-
| **
|
|
280
|
+
| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
|
|
281
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
522
282
|
|
|
523
283
|
|
|
524
284
|
### Return type
|
|
525
285
|
|
|
526
|
-
**
|
|
286
|
+
**Array<OrderSummaryDTO>**
|
|
527
287
|
|
|
528
288
|
### Authorization
|
|
529
289
|
|
|
@@ -538,17 +298,17 @@ No authorization required
|
|
|
538
298
|
### HTTP response details
|
|
539
299
|
| Status code | Description | Response headers |
|
|
540
300
|
|-------------|-------------|------------------|
|
|
541
|
-
|**200** |
|
|
301
|
+
|**200** | Order Summaries | - |
|
|
542
302
|
|**400** | Bad Request | - |
|
|
543
303
|
|**401** | Unauthorised | - |
|
|
544
304
|
|**403** | Access Denied | - |
|
|
545
305
|
|
|
546
306
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
547
307
|
|
|
548
|
-
# **
|
|
549
|
-
> Array<OrderSummaryDTO>
|
|
308
|
+
# **postGetOrders**
|
|
309
|
+
> Array<OrderSummaryDTO> postGetOrders()
|
|
550
310
|
|
|
551
|
-
Create An Order (
|
|
311
|
+
Create An Order (Beta)
|
|
552
312
|
|
|
553
313
|
### Example
|
|
554
314
|
|
|
@@ -556,18 +316,18 @@ Create An Order (Admin)
|
|
|
556
316
|
import {
|
|
557
317
|
OrdersApi,
|
|
558
318
|
Configuration,
|
|
559
|
-
|
|
319
|
+
CustomerOrderRequestDTO
|
|
560
320
|
} from 'yellowgrid-api-ts';
|
|
561
321
|
|
|
562
322
|
const configuration = new Configuration();
|
|
563
323
|
const apiInstance = new OrdersApi(configuration);
|
|
564
324
|
|
|
565
325
|
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
566
|
-
let
|
|
326
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
567
327
|
|
|
568
|
-
const { status, data } = await apiInstance.
|
|
328
|
+
const { status, data } = await apiInstance.postGetOrders(
|
|
569
329
|
readonly,
|
|
570
|
-
|
|
330
|
+
customerOrderRequestDTO
|
|
571
331
|
);
|
|
572
332
|
```
|
|
573
333
|
|
|
@@ -575,7 +335,7 @@ const { status, data } = await apiInstance.postCreateAdminOrder(
|
|
|
575
335
|
|
|
576
336
|
|Name | Type | Description | Notes|
|
|
577
337
|
|------------- | ------------- | ------------- | -------------|
|
|
578
|
-
| **
|
|
338
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
579
339
|
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
580
340
|
|
|
581
341
|
|
|
@@ -603,10 +363,10 @@ No authorization required
|
|
|
603
363
|
|
|
604
364
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
605
365
|
|
|
606
|
-
# **
|
|
607
|
-
>
|
|
366
|
+
# **putUpdateAdminOrder**
|
|
367
|
+
> Array<OrderSummaryDTO> putUpdateAdminOrder()
|
|
608
368
|
|
|
609
|
-
|
|
369
|
+
Update An Order (Admin)
|
|
610
370
|
|
|
611
371
|
### Example
|
|
612
372
|
|
|
@@ -614,20 +374,20 @@ Create Shipping Consignment
|
|
|
614
374
|
import {
|
|
615
375
|
OrdersApi,
|
|
616
376
|
Configuration,
|
|
617
|
-
|
|
377
|
+
AdminOrderRequestDTO
|
|
618
378
|
} from 'yellowgrid-api-ts';
|
|
619
379
|
|
|
620
380
|
const configuration = new Configuration();
|
|
621
381
|
const apiInstance = new OrdersApi(configuration);
|
|
622
382
|
|
|
623
383
|
let id: number; //Order ID (default to undefined)
|
|
624
|
-
let
|
|
625
|
-
let
|
|
384
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
385
|
+
let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
|
|
626
386
|
|
|
627
|
-
const { status, data } = await apiInstance.
|
|
387
|
+
const { status, data } = await apiInstance.putUpdateAdminOrder(
|
|
628
388
|
id,
|
|
629
|
-
|
|
630
|
-
|
|
389
|
+
readonly,
|
|
390
|
+
adminOrderRequestDTO
|
|
631
391
|
);
|
|
632
392
|
```
|
|
633
393
|
|
|
@@ -635,14 +395,14 @@ const { status, data } = await apiInstance.postCreateConsignment(
|
|
|
635
395
|
|
|
636
396
|
|Name | Type | Description | Notes|
|
|
637
397
|
|------------- | ------------- | ------------- | -------------|
|
|
638
|
-
| **
|
|
398
|
+
| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
|
|
639
399
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
640
|
-
| **
|
|
400
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
641
401
|
|
|
642
402
|
|
|
643
403
|
### Return type
|
|
644
404
|
|
|
645
|
-
**
|
|
405
|
+
**Array<OrderSummaryDTO>**
|
|
646
406
|
|
|
647
407
|
### Authorization
|
|
648
408
|
|
|
@@ -657,17 +417,17 @@ No authorization required
|
|
|
657
417
|
### HTTP response details
|
|
658
418
|
| Status code | Description | Response headers |
|
|
659
419
|
|-------------|-------------|------------------|
|
|
660
|
-
|**200** |
|
|
420
|
+
|**200** | Order Summaries | - |
|
|
661
421
|
|**400** | Bad Request | - |
|
|
662
422
|
|**401** | Unauthorised | - |
|
|
663
423
|
|**403** | Access Denied | - |
|
|
664
424
|
|
|
665
425
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
666
426
|
|
|
667
|
-
# **
|
|
668
|
-
>
|
|
427
|
+
# **putUpdateOrder**
|
|
428
|
+
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
669
429
|
|
|
670
|
-
|
|
430
|
+
Update An Order (Beta)
|
|
671
431
|
|
|
672
432
|
### Example
|
|
673
433
|
|
|
@@ -675,20 +435,20 @@ Create Shipment (Admin)
|
|
|
675
435
|
import {
|
|
676
436
|
OrdersApi,
|
|
677
437
|
Configuration,
|
|
678
|
-
|
|
438
|
+
CustomerOrderRequestDTO
|
|
679
439
|
} from 'yellowgrid-api-ts';
|
|
680
440
|
|
|
681
441
|
const configuration = new Configuration();
|
|
682
442
|
const apiInstance = new OrdersApi(configuration);
|
|
683
443
|
|
|
684
444
|
let id: number; //Order ID (default to undefined)
|
|
685
|
-
let
|
|
686
|
-
let
|
|
445
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
446
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
687
447
|
|
|
688
|
-
const { status, data } = await apiInstance.
|
|
448
|
+
const { status, data } = await apiInstance.putUpdateOrder(
|
|
689
449
|
id,
|
|
690
|
-
|
|
691
|
-
|
|
450
|
+
readonly,
|
|
451
|
+
customerOrderRequestDTO
|
|
692
452
|
);
|
|
693
453
|
```
|
|
694
454
|
|
|
@@ -696,608 +456,14 @@ const { status, data } = await apiInstance.postCreateShipment(
|
|
|
696
456
|
|
|
697
457
|
|Name | Type | Description | Notes|
|
|
698
458
|
|------------- | ------------- | ------------- | -------------|
|
|
699
|
-
| **
|
|
459
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
700
460
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
701
|
-
| **
|
|
461
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
702
462
|
|
|
703
463
|
|
|
704
464
|
### Return type
|
|
705
465
|
|
|
706
|
-
**
|
|
707
|
-
|
|
708
|
-
### Authorization
|
|
709
|
-
|
|
710
|
-
No authorization required
|
|
711
|
-
|
|
712
|
-
### HTTP request headers
|
|
713
|
-
|
|
714
|
-
- **Content-Type**: application/json
|
|
715
|
-
- **Accept**: application/json
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
### HTTP response details
|
|
719
|
-
| Status code | Description | Response headers |
|
|
720
|
-
|-------------|-------------|------------------|
|
|
721
|
-
|**200** | Shipment | - |
|
|
722
|
-
|**400** | Bad Request | - |
|
|
723
|
-
|**401** | Unauthorised | - |
|
|
724
|
-
|**403** | Access Denied | - |
|
|
725
|
-
|
|
726
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
727
|
-
|
|
728
|
-
# **postGetOrders**
|
|
729
|
-
> Array<OrderSummaryDTO> postGetOrders()
|
|
730
|
-
|
|
731
|
-
Create An Order (Beta)
|
|
732
|
-
|
|
733
|
-
### Example
|
|
734
|
-
|
|
735
|
-
```typescript
|
|
736
|
-
import {
|
|
737
|
-
OrdersApi,
|
|
738
|
-
Configuration,
|
|
739
|
-
CustomerOrderRequestDTO
|
|
740
|
-
} from 'yellowgrid-api-ts';
|
|
741
|
-
|
|
742
|
-
const configuration = new Configuration();
|
|
743
|
-
const apiInstance = new OrdersApi(configuration);
|
|
744
|
-
|
|
745
|
-
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
746
|
-
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
747
|
-
|
|
748
|
-
const { status, data } = await apiInstance.postGetOrders(
|
|
749
|
-
readonly,
|
|
750
|
-
customerOrderRequestDTO
|
|
751
|
-
);
|
|
752
|
-
```
|
|
753
|
-
|
|
754
|
-
### Parameters
|
|
755
|
-
|
|
756
|
-
|Name | Type | Description | Notes|
|
|
757
|
-
|------------- | ------------- | ------------- | -------------|
|
|
758
|
-
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
759
|
-
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
### Return type
|
|
763
|
-
|
|
764
|
-
**Array<OrderSummaryDTO>**
|
|
765
|
-
|
|
766
|
-
### Authorization
|
|
767
|
-
|
|
768
|
-
No authorization required
|
|
769
|
-
|
|
770
|
-
### HTTP request headers
|
|
771
|
-
|
|
772
|
-
- **Content-Type**: application/json
|
|
773
|
-
- **Accept**: application/json
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
### HTTP response details
|
|
777
|
-
| Status code | Description | Response headers |
|
|
778
|
-
|-------------|-------------|------------------|
|
|
779
|
-
|**200** | Order Summaries | - |
|
|
780
|
-
|**400** | Bad Request | - |
|
|
781
|
-
|**401** | Unauthorised | - |
|
|
782
|
-
|**403** | Access Denied | - |
|
|
783
|
-
|
|
784
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
785
|
-
|
|
786
|
-
# **postIssueCredit**
|
|
787
|
-
> CreditNoteModel postIssueCredit()
|
|
788
|
-
|
|
789
|
-
Issue Credit (Admin)
|
|
790
|
-
|
|
791
|
-
### Example
|
|
792
|
-
|
|
793
|
-
```typescript
|
|
794
|
-
import {
|
|
795
|
-
OrdersApi,
|
|
796
|
-
Configuration,
|
|
797
|
-
CreditNoteDTO
|
|
798
|
-
} from 'yellowgrid-api-ts';
|
|
799
|
-
|
|
800
|
-
const configuration = new Configuration();
|
|
801
|
-
const apiInstance = new OrdersApi(configuration);
|
|
802
|
-
|
|
803
|
-
let id: number; //Order ID (default to undefined)
|
|
804
|
-
let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
|
|
805
|
-
|
|
806
|
-
const { status, data } = await apiInstance.postIssueCredit(
|
|
807
|
-
id,
|
|
808
|
-
creditNoteDTO
|
|
809
|
-
);
|
|
810
|
-
```
|
|
811
|
-
|
|
812
|
-
### Parameters
|
|
813
|
-
|
|
814
|
-
|Name | Type | Description | Notes|
|
|
815
|
-
|------------- | ------------- | ------------- | -------------|
|
|
816
|
-
| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
|
|
817
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
### Return type
|
|
821
|
-
|
|
822
|
-
**CreditNoteModel**
|
|
823
|
-
|
|
824
|
-
### Authorization
|
|
825
|
-
|
|
826
|
-
No authorization required
|
|
827
|
-
|
|
828
|
-
### HTTP request headers
|
|
829
|
-
|
|
830
|
-
- **Content-Type**: application/json
|
|
831
|
-
- **Accept**: application/json
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
### HTTP response details
|
|
835
|
-
| Status code | Description | Response headers |
|
|
836
|
-
|-------------|-------------|------------------|
|
|
837
|
-
|**200** | Credit Note | - |
|
|
838
|
-
|**400** | Bad Request | - |
|
|
839
|
-
|**401** | Unauthorised | - |
|
|
840
|
-
|**403** | Access Denied | - |
|
|
841
|
-
|
|
842
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
843
|
-
|
|
844
|
-
# **postPrintShippingLabel**
|
|
845
|
-
> File postPrintShippingLabel()
|
|
846
|
-
|
|
847
|
-
Print Shipment Label
|
|
848
|
-
|
|
849
|
-
### Example
|
|
850
|
-
|
|
851
|
-
```typescript
|
|
852
|
-
import {
|
|
853
|
-
OrdersApi,
|
|
854
|
-
Configuration
|
|
855
|
-
} from 'yellowgrid-api-ts';
|
|
856
|
-
|
|
857
|
-
const configuration = new Configuration();
|
|
858
|
-
const apiInstance = new OrdersApi(configuration);
|
|
859
|
-
|
|
860
|
-
let id: number; //Order ID (default to undefined)
|
|
861
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
862
|
-
let printer: 1 | 2 | 3; //Printer (default to undefined)
|
|
863
|
-
|
|
864
|
-
const { status, data } = await apiInstance.postPrintShippingLabel(
|
|
865
|
-
id,
|
|
866
|
-
shipmentId,
|
|
867
|
-
printer
|
|
868
|
-
);
|
|
869
|
-
```
|
|
870
|
-
|
|
871
|
-
### Parameters
|
|
872
|
-
|
|
873
|
-
|Name | Type | Description | Notes|
|
|
874
|
-
|------------- | ------------- | ------------- | -------------|
|
|
875
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
876
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
877
|
-
| **printer** | [**1 | 2 | 3**]**Array<1 | 2 | 3>** | Printer | defaults to undefined|
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
### Return type
|
|
881
|
-
|
|
882
|
-
**File**
|
|
883
|
-
|
|
884
|
-
### Authorization
|
|
885
|
-
|
|
886
|
-
No authorization required
|
|
887
|
-
|
|
888
|
-
### HTTP request headers
|
|
889
|
-
|
|
890
|
-
- **Content-Type**: Not defined
|
|
891
|
-
- **Accept**: text/html, application/json
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
### HTTP response details
|
|
895
|
-
| Status code | Description | Response headers |
|
|
896
|
-
|-------------|-------------|------------------|
|
|
897
|
-
|**200** | Shipping Label | - |
|
|
898
|
-
|**400** | Bad Request | - |
|
|
899
|
-
|**401** | Unauthorised | - |
|
|
900
|
-
|**403** | Access Denied | - |
|
|
901
|
-
|
|
902
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
903
|
-
|
|
904
|
-
# **postSendOrderEmail**
|
|
905
|
-
> postSendOrderEmail()
|
|
906
|
-
|
|
907
|
-
Send Order Email
|
|
908
|
-
|
|
909
|
-
### Example
|
|
910
|
-
|
|
911
|
-
```typescript
|
|
912
|
-
import {
|
|
913
|
-
OrdersApi,
|
|
914
|
-
Configuration
|
|
915
|
-
} from 'yellowgrid-api-ts';
|
|
916
|
-
|
|
917
|
-
const configuration = new Configuration();
|
|
918
|
-
const apiInstance = new OrdersApi(configuration);
|
|
919
|
-
|
|
920
|
-
let id: number; //Order ID (default to undefined)
|
|
921
|
-
let email: string; //Email Address (default to undefined)
|
|
922
|
-
|
|
923
|
-
const { status, data } = await apiInstance.postSendOrderEmail(
|
|
924
|
-
id,
|
|
925
|
-
email
|
|
926
|
-
);
|
|
927
|
-
```
|
|
928
|
-
|
|
929
|
-
### Parameters
|
|
930
|
-
|
|
931
|
-
|Name | Type | Description | Notes|
|
|
932
|
-
|------------- | ------------- | ------------- | -------------|
|
|
933
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
934
|
-
| **email** | [**string**] | Email Address | defaults to undefined|
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
### Return type
|
|
938
|
-
|
|
939
|
-
void (empty response body)
|
|
940
|
-
|
|
941
|
-
### Authorization
|
|
942
|
-
|
|
943
|
-
No authorization required
|
|
944
|
-
|
|
945
|
-
### HTTP request headers
|
|
946
|
-
|
|
947
|
-
- **Content-Type**: Not defined
|
|
948
|
-
- **Accept**: Not defined
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
### HTTP response details
|
|
952
|
-
| Status code | Description | Response headers |
|
|
953
|
-
|-------------|-------------|------------------|
|
|
954
|
-
|**200** | No Response | - |
|
|
955
|
-
|**400** | Bad Request | - |
|
|
956
|
-
|**401** | Unauthorised | - |
|
|
957
|
-
|**403** | Access Denied | - |
|
|
958
|
-
|
|
959
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
960
|
-
|
|
961
|
-
# **postSendShipmentEmail**
|
|
962
|
-
> postSendShipmentEmail()
|
|
963
|
-
|
|
964
|
-
Send Shipment Email (Admin)
|
|
965
|
-
|
|
966
|
-
### Example
|
|
967
|
-
|
|
968
|
-
```typescript
|
|
969
|
-
import {
|
|
970
|
-
OrdersApi,
|
|
971
|
-
Configuration
|
|
972
|
-
} from 'yellowgrid-api-ts';
|
|
973
|
-
|
|
974
|
-
const configuration = new Configuration();
|
|
975
|
-
const apiInstance = new OrdersApi(configuration);
|
|
976
|
-
|
|
977
|
-
let id: number; //Order ID (default to undefined)
|
|
978
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
979
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
980
|
-
let email: string; //Email Address (default to undefined)
|
|
981
|
-
|
|
982
|
-
const { status, data } = await apiInstance.postSendShipmentEmail(
|
|
983
|
-
id,
|
|
984
|
-
batchId,
|
|
985
|
-
shipmentId,
|
|
986
|
-
email
|
|
987
|
-
);
|
|
988
|
-
```
|
|
989
|
-
|
|
990
|
-
### Parameters
|
|
991
|
-
|
|
992
|
-
|Name | Type | Description | Notes|
|
|
993
|
-
|------------- | ------------- | ------------- | -------------|
|
|
994
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
995
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
996
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
997
|
-
| **email** | [**string**] | Email Address | defaults to undefined|
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
### Return type
|
|
1001
|
-
|
|
1002
|
-
void (empty response body)
|
|
1003
|
-
|
|
1004
|
-
### Authorization
|
|
1005
|
-
|
|
1006
|
-
No authorization required
|
|
1007
|
-
|
|
1008
|
-
### HTTP request headers
|
|
1009
|
-
|
|
1010
|
-
- **Content-Type**: Not defined
|
|
1011
|
-
- **Accept**: Not defined
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
### HTTP response details
|
|
1015
|
-
| Status code | Description | Response headers |
|
|
1016
|
-
|-------------|-------------|------------------|
|
|
1017
|
-
|**200** | No Response | - |
|
|
1018
|
-
|**400** | Bad Request | - |
|
|
1019
|
-
|**401** | Unauthorised | - |
|
|
1020
|
-
|**403** | Access Denied | - |
|
|
1021
|
-
|
|
1022
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1023
|
-
|
|
1024
|
-
# **postSendSupplierEmail**
|
|
1025
|
-
> postSendSupplierEmail()
|
|
1026
|
-
|
|
1027
|
-
Send Supplier Email
|
|
1028
|
-
|
|
1029
|
-
### Example
|
|
1030
|
-
|
|
1031
|
-
```typescript
|
|
1032
|
-
import {
|
|
1033
|
-
OrdersApi,
|
|
1034
|
-
Configuration
|
|
1035
|
-
} from 'yellowgrid-api-ts';
|
|
1036
|
-
|
|
1037
|
-
const configuration = new Configuration();
|
|
1038
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1039
|
-
|
|
1040
|
-
let id: number; //Order ID (default to undefined)
|
|
1041
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
1042
|
-
|
|
1043
|
-
const { status, data } = await apiInstance.postSendSupplierEmail(
|
|
1044
|
-
id,
|
|
1045
|
-
batchId
|
|
1046
|
-
);
|
|
1047
|
-
```
|
|
1048
|
-
|
|
1049
|
-
### Parameters
|
|
1050
|
-
|
|
1051
|
-
|Name | Type | Description | Notes|
|
|
1052
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1053
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1054
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
### Return type
|
|
1058
|
-
|
|
1059
|
-
void (empty response body)
|
|
1060
|
-
|
|
1061
|
-
### Authorization
|
|
1062
|
-
|
|
1063
|
-
No authorization required
|
|
1064
|
-
|
|
1065
|
-
### HTTP request headers
|
|
1066
|
-
|
|
1067
|
-
- **Content-Type**: Not defined
|
|
1068
|
-
- **Accept**: Not defined
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
### HTTP response details
|
|
1072
|
-
| Status code | Description | Response headers |
|
|
1073
|
-
|-------------|-------------|------------------|
|
|
1074
|
-
|**200** | No Response | - |
|
|
1075
|
-
|**400** | Bad Request | - |
|
|
1076
|
-
|**401** | Unauthorised | - |
|
|
1077
|
-
|**403** | Access Denied | - |
|
|
1078
|
-
|
|
1079
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1080
|
-
|
|
1081
|
-
# **postSplitOrder**
|
|
1082
|
-
> Array<OrderSummaryDTO> postSplitOrder()
|
|
1083
|
-
|
|
1084
|
-
Split Order
|
|
1085
|
-
|
|
1086
|
-
### Example
|
|
1087
|
-
|
|
1088
|
-
```typescript
|
|
1089
|
-
import {
|
|
1090
|
-
OrdersApi,
|
|
1091
|
-
Configuration,
|
|
1092
|
-
PostSplitOrderRequest
|
|
1093
|
-
} from 'yellowgrid-api-ts';
|
|
1094
|
-
|
|
1095
|
-
const configuration = new Configuration();
|
|
1096
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1097
|
-
|
|
1098
|
-
let id: number; //Order ID (default to undefined)
|
|
1099
|
-
let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
|
|
1100
|
-
|
|
1101
|
-
const { status, data } = await apiInstance.postSplitOrder(
|
|
1102
|
-
id,
|
|
1103
|
-
postSplitOrderRequest
|
|
1104
|
-
);
|
|
1105
|
-
```
|
|
1106
|
-
|
|
1107
|
-
### Parameters
|
|
1108
|
-
|
|
1109
|
-
|Name | Type | Description | Notes|
|
|
1110
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1111
|
-
| **postSplitOrderRequest** | **PostSplitOrderRequest**| | |
|
|
1112
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
### Return type
|
|
1116
|
-
|
|
1117
|
-
**Array<OrderSummaryDTO>**
|
|
1118
|
-
|
|
1119
|
-
### Authorization
|
|
1120
|
-
|
|
1121
|
-
No authorization required
|
|
1122
|
-
|
|
1123
|
-
### HTTP request headers
|
|
1124
|
-
|
|
1125
|
-
- **Content-Type**: application/json
|
|
1126
|
-
- **Accept**: application/json
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
### HTTP response details
|
|
1130
|
-
| Status code | Description | Response headers |
|
|
1131
|
-
|-------------|-------------|------------------|
|
|
1132
|
-
|**200** | Order Summaries | - |
|
|
1133
|
-
|**400** | Bad Request | - |
|
|
1134
|
-
|**401** | Unauthorised | - |
|
|
1135
|
-
|**403** | Access Denied | - |
|
|
1136
|
-
|
|
1137
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1138
|
-
|
|
1139
|
-
# **putAllocateItems**
|
|
1140
|
-
> Array<BatchDTO> putAllocateItems()
|
|
1141
|
-
|
|
1142
|
-
Allocate Items To Supplier
|
|
1143
|
-
|
|
1144
|
-
### Example
|
|
1145
|
-
|
|
1146
|
-
```typescript
|
|
1147
|
-
import {
|
|
1148
|
-
OrdersApi,
|
|
1149
|
-
Configuration,
|
|
1150
|
-
PutAllocateItemsRequest
|
|
1151
|
-
} from 'yellowgrid-api-ts';
|
|
1152
|
-
|
|
1153
|
-
const configuration = new Configuration();
|
|
1154
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1155
|
-
|
|
1156
|
-
let id: number; //Order ID (default to undefined)
|
|
1157
|
-
let supplierId: number; //Supplier ID (default to undefined)
|
|
1158
|
-
let putAllocateItemsRequest: PutAllocateItemsRequest; // (optional)
|
|
1159
|
-
|
|
1160
|
-
const { status, data } = await apiInstance.putAllocateItems(
|
|
1161
|
-
id,
|
|
1162
|
-
supplierId,
|
|
1163
|
-
putAllocateItemsRequest
|
|
1164
|
-
);
|
|
1165
|
-
```
|
|
1166
|
-
|
|
1167
|
-
### Parameters
|
|
1168
|
-
|
|
1169
|
-
|Name | Type | Description | Notes|
|
|
1170
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1171
|
-
| **putAllocateItemsRequest** | **PutAllocateItemsRequest**| | |
|
|
1172
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1173
|
-
| **supplierId** | [**number**] | Supplier ID | defaults to undefined|
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
### Return type
|
|
1177
|
-
|
|
1178
|
-
**Array<BatchDTO>**
|
|
1179
|
-
|
|
1180
|
-
### Authorization
|
|
1181
|
-
|
|
1182
|
-
No authorization required
|
|
1183
|
-
|
|
1184
|
-
### HTTP request headers
|
|
1185
|
-
|
|
1186
|
-
- **Content-Type**: application/json
|
|
1187
|
-
- **Accept**: application/json
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
### HTTP response details
|
|
1191
|
-
| Status code | Description | Response headers |
|
|
1192
|
-
|-------------|-------------|------------------|
|
|
1193
|
-
|**200** | Order Batches | - |
|
|
1194
|
-
|**400** | Bad Request | - |
|
|
1195
|
-
|**401** | Unauthorised | - |
|
|
1196
|
-
|**403** | Access Denied | - |
|
|
1197
|
-
|
|
1198
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1199
|
-
|
|
1200
|
-
# **putUpdateAdminOrder**
|
|
1201
|
-
> Array<OrderSummaryDTO> putUpdateAdminOrder()
|
|
1202
|
-
|
|
1203
|
-
Update An Order (Admin)
|
|
1204
|
-
|
|
1205
|
-
### Example
|
|
1206
|
-
|
|
1207
|
-
```typescript
|
|
1208
|
-
import {
|
|
1209
|
-
OrdersApi,
|
|
1210
|
-
Configuration,
|
|
1211
|
-
AdminOrderRequestDTO
|
|
1212
|
-
} from 'yellowgrid-api-ts';
|
|
1213
|
-
|
|
1214
|
-
const configuration = new Configuration();
|
|
1215
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1216
|
-
|
|
1217
|
-
let id: number; //Order ID (default to undefined)
|
|
1218
|
-
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
1219
|
-
let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
|
|
1220
|
-
|
|
1221
|
-
const { status, data } = await apiInstance.putUpdateAdminOrder(
|
|
1222
|
-
id,
|
|
1223
|
-
readonly,
|
|
1224
|
-
adminOrderRequestDTO
|
|
1225
|
-
);
|
|
1226
|
-
```
|
|
1227
|
-
|
|
1228
|
-
### Parameters
|
|
1229
|
-
|
|
1230
|
-
|Name | Type | Description | Notes|
|
|
1231
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1232
|
-
| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
|
|
1233
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1234
|
-
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
### Return type
|
|
1238
|
-
|
|
1239
|
-
**Array<OrderSummaryDTO>**
|
|
1240
|
-
|
|
1241
|
-
### Authorization
|
|
1242
|
-
|
|
1243
|
-
No authorization required
|
|
1244
|
-
|
|
1245
|
-
### HTTP request headers
|
|
1246
|
-
|
|
1247
|
-
- **Content-Type**: application/json
|
|
1248
|
-
- **Accept**: application/json
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
### HTTP response details
|
|
1252
|
-
| Status code | Description | Response headers |
|
|
1253
|
-
|-------------|-------------|------------------|
|
|
1254
|
-
|**200** | Order Summaries | - |
|
|
1255
|
-
|**400** | Bad Request | - |
|
|
1256
|
-
|**401** | Unauthorised | - |
|
|
1257
|
-
|**403** | Access Denied | - |
|
|
1258
|
-
|
|
1259
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1260
|
-
|
|
1261
|
-
# **putUpdateOrder**
|
|
1262
|
-
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
1263
|
-
|
|
1264
|
-
Update An Order (Beta)
|
|
1265
|
-
|
|
1266
|
-
### Example
|
|
1267
|
-
|
|
1268
|
-
```typescript
|
|
1269
|
-
import {
|
|
1270
|
-
OrdersApi,
|
|
1271
|
-
Configuration,
|
|
1272
|
-
CustomerOrderRequestDTO
|
|
1273
|
-
} from 'yellowgrid-api-ts';
|
|
1274
|
-
|
|
1275
|
-
const configuration = new Configuration();
|
|
1276
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1277
|
-
|
|
1278
|
-
let id: number; //Order ID (default to undefined)
|
|
1279
|
-
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
1280
|
-
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
1281
|
-
|
|
1282
|
-
const { status, data } = await apiInstance.putUpdateOrder(
|
|
1283
|
-
id,
|
|
1284
|
-
readonly,
|
|
1285
|
-
customerOrderRequestDTO
|
|
1286
|
-
);
|
|
1287
|
-
```
|
|
1288
|
-
|
|
1289
|
-
### Parameters
|
|
1290
|
-
|
|
1291
|
-
|Name | Type | Description | Notes|
|
|
1292
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1293
|
-
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
1294
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1295
|
-
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
### Return type
|
|
1299
|
-
|
|
1300
|
-
**Array<OrderSummaryDTO>**
|
|
466
|
+
**Array<OrderSummaryDTO>**
|
|
1301
467
|
|
|
1302
468
|
### Authorization
|
|
1303
469
|
|
|
@@ -1319,67 +485,3 @@ No authorization required
|
|
|
1319
485
|
|
|
1320
486
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1321
487
|
|
|
1322
|
-
# **putUpdateShipment**
|
|
1323
|
-
> ShipmentDTO putUpdateShipment()
|
|
1324
|
-
|
|
1325
|
-
Update Shipment (Admin)
|
|
1326
|
-
|
|
1327
|
-
### Example
|
|
1328
|
-
|
|
1329
|
-
```typescript
|
|
1330
|
-
import {
|
|
1331
|
-
OrdersApi,
|
|
1332
|
-
Configuration,
|
|
1333
|
-
ShipmentRequestDTO
|
|
1334
|
-
} from 'yellowgrid-api-ts';
|
|
1335
|
-
|
|
1336
|
-
const configuration = new Configuration();
|
|
1337
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1338
|
-
|
|
1339
|
-
let id: number; //Order ID (default to undefined)
|
|
1340
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
1341
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
1342
|
-
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
1343
|
-
|
|
1344
|
-
const { status, data } = await apiInstance.putUpdateShipment(
|
|
1345
|
-
id,
|
|
1346
|
-
batchId,
|
|
1347
|
-
shipmentId,
|
|
1348
|
-
shipmentRequestDTO
|
|
1349
|
-
);
|
|
1350
|
-
```
|
|
1351
|
-
|
|
1352
|
-
### Parameters
|
|
1353
|
-
|
|
1354
|
-
|Name | Type | Description | Notes|
|
|
1355
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1356
|
-
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
1357
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1358
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1359
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
### Return type
|
|
1363
|
-
|
|
1364
|
-
**ShipmentDTO**
|
|
1365
|
-
|
|
1366
|
-
### Authorization
|
|
1367
|
-
|
|
1368
|
-
No authorization required
|
|
1369
|
-
|
|
1370
|
-
### HTTP request headers
|
|
1371
|
-
|
|
1372
|
-
- **Content-Type**: application/json
|
|
1373
|
-
- **Accept**: application/json
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
### HTTP response details
|
|
1377
|
-
| Status code | Description | Response headers |
|
|
1378
|
-
|-------------|-------------|------------------|
|
|
1379
|
-
|**200** | Shipment | - |
|
|
1380
|
-
|**400** | Bad Request | - |
|
|
1381
|
-
|**401** | Unauthorised | - |
|
|
1382
|
-
|**403** | Access Denied | - |
|
|
1383
|
-
|
|
1384
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1385
|
-
|