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