yellowgrid-api-ts 3.2.55-dev.0 → 3.2.55
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 +229 -249
- package/README.md +0 -34
- package/api.ts +207 -2373
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/config.json +3 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +105 -1727
- package/dist/api.js +84 -1379
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/OrdersApi.md +12 -788
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/package.json +1 -1
- 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 -57
- 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/OrderDetailsDTO.md +0 -63
- package/docs/OrderItemDTO.md +0 -53
- package/docs/OrderedItemModel.md +0 -47
- package/docs/PostAddOrderNoteRequest.md +0 -20
- 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 -31
- 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/SupplierModel.md +0 -37
- package/hs_err_pid58424.log +0 -247
- package/models/CourierEnum.ts +0 -19
- package/models/PrinterEnum.ts +0 -19
package/docs/OrdersApi.md
CHANGED
|
@@ -4,88 +4,15 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteCreateShipment**](#deletecreateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments | Delete Shipment (Admin)|
|
|
8
7
|
|[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
|
|
9
8
|
|[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
|
|
10
|
-
|[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
|
|
11
9
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
12
|
-
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
13
10
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
14
|
-
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
15
11
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
16
|
-
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
17
|
-
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
18
12
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
19
|
-
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
20
|
-
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
21
|
-
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
22
|
-
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
23
|
-
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
24
|
-
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
25
|
-
|[**putCreateShipment**](#putcreateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments | Update Shipment (Admin)|
|
|
26
13
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
27
14
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
28
15
|
|
|
29
|
-
# **deleteCreateShipment**
|
|
30
|
-
> deleteCreateShipment()
|
|
31
|
-
|
|
32
|
-
Delete Shipment (Admin)
|
|
33
|
-
|
|
34
|
-
### Example
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
import {
|
|
38
|
-
OrdersApi,
|
|
39
|
-
Configuration
|
|
40
|
-
} from 'yellowgrid-api-ts';
|
|
41
|
-
|
|
42
|
-
const configuration = new Configuration();
|
|
43
|
-
const apiInstance = new OrdersApi(configuration);
|
|
44
|
-
|
|
45
|
-
let id: number; //Order ID (default to undefined)
|
|
46
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
47
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
48
|
-
|
|
49
|
-
const { status, data } = await apiInstance.deleteCreateShipment(
|
|
50
|
-
id,
|
|
51
|
-
batchId,
|
|
52
|
-
shipmentId
|
|
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
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
### Return type
|
|
66
|
-
|
|
67
|
-
void (empty response body)
|
|
68
|
-
|
|
69
|
-
### Authorization
|
|
70
|
-
|
|
71
|
-
No authorization required
|
|
72
|
-
|
|
73
|
-
### HTTP request headers
|
|
74
|
-
|
|
75
|
-
- **Content-Type**: Not defined
|
|
76
|
-
- **Accept**: Not defined
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
### HTTP response details
|
|
80
|
-
| Status code | Description | Response headers |
|
|
81
|
-
|-------------|-------------|------------------|
|
|
82
|
-
|**200** | No Response | - |
|
|
83
|
-
|**400** | Bad Request | - |
|
|
84
|
-
|**401** | Unauthorised | - |
|
|
85
|
-
|**403** | Access Denied | - |
|
|
86
|
-
|
|
87
|
-
[[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)
|
|
88
|
-
|
|
89
16
|
# **deleteUpdateOrder**
|
|
90
17
|
> deleteUpdateOrder()
|
|
91
18
|
|
|
@@ -194,60 +121,6 @@ No authorization required
|
|
|
194
121
|
|
|
195
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)
|
|
196
123
|
|
|
197
|
-
# **getGetAdminOrderDetails**
|
|
198
|
-
> OrderDetailsDTO getGetAdminOrderDetails()
|
|
199
|
-
|
|
200
|
-
Get Order Details (Admin)
|
|
201
|
-
|
|
202
|
-
### Example
|
|
203
|
-
|
|
204
|
-
```typescript
|
|
205
|
-
import {
|
|
206
|
-
OrdersApi,
|
|
207
|
-
Configuration
|
|
208
|
-
} from 'yellowgrid-api-ts';
|
|
209
|
-
|
|
210
|
-
const configuration = new Configuration();
|
|
211
|
-
const apiInstance = new OrdersApi(configuration);
|
|
212
|
-
|
|
213
|
-
let id: number; //Order ID (default to undefined)
|
|
214
|
-
|
|
215
|
-
const { status, data } = await apiInstance.getGetAdminOrderDetails(
|
|
216
|
-
id
|
|
217
|
-
);
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
### Parameters
|
|
221
|
-
|
|
222
|
-
|Name | Type | Description | Notes|
|
|
223
|
-
|------------- | ------------- | ------------- | -------------|
|
|
224
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
### Return type
|
|
228
|
-
|
|
229
|
-
**OrderDetailsDTO**
|
|
230
|
-
|
|
231
|
-
### Authorization
|
|
232
|
-
|
|
233
|
-
No authorization required
|
|
234
|
-
|
|
235
|
-
### HTTP request headers
|
|
236
|
-
|
|
237
|
-
- **Content-Type**: Not defined
|
|
238
|
-
- **Accept**: application/json
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
### HTTP response details
|
|
242
|
-
| Status code | Description | Response headers |
|
|
243
|
-
|-------------|-------------|------------------|
|
|
244
|
-
|**200** | Order Details | - |
|
|
245
|
-
|**400** | Bad Request | - |
|
|
246
|
-
|**401** | Unauthorised | - |
|
|
247
|
-
|**403** | Access Denied | - |
|
|
248
|
-
|
|
249
|
-
[[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)
|
|
250
|
-
|
|
251
124
|
# **getGetEditableOrder**
|
|
252
125
|
> DetailedOrderRequestDTO getGetEditableOrder()
|
|
253
126
|
|
|
@@ -302,60 +175,6 @@ No authorization required
|
|
|
302
175
|
|
|
303
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)
|
|
304
177
|
|
|
305
|
-
# **getGetOrderPdf**
|
|
306
|
-
> File getGetOrderPdf()
|
|
307
|
-
|
|
308
|
-
Download Order PDF
|
|
309
|
-
|
|
310
|
-
### Example
|
|
311
|
-
|
|
312
|
-
```typescript
|
|
313
|
-
import {
|
|
314
|
-
OrdersApi,
|
|
315
|
-
Configuration
|
|
316
|
-
} from 'yellowgrid-api-ts';
|
|
317
|
-
|
|
318
|
-
const configuration = new Configuration();
|
|
319
|
-
const apiInstance = new OrdersApi(configuration);
|
|
320
|
-
|
|
321
|
-
let id: number; //Order ID (default to undefined)
|
|
322
|
-
|
|
323
|
-
const { status, data } = await apiInstance.getGetOrderPdf(
|
|
324
|
-
id
|
|
325
|
-
);
|
|
326
|
-
```
|
|
327
|
-
|
|
328
|
-
### Parameters
|
|
329
|
-
|
|
330
|
-
|Name | Type | Description | Notes|
|
|
331
|
-
|------------- | ------------- | ------------- | -------------|
|
|
332
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
### Return type
|
|
336
|
-
|
|
337
|
-
**File**
|
|
338
|
-
|
|
339
|
-
### Authorization
|
|
340
|
-
|
|
341
|
-
No authorization required
|
|
342
|
-
|
|
343
|
-
### HTTP request headers
|
|
344
|
-
|
|
345
|
-
- **Content-Type**: Not defined
|
|
346
|
-
- **Accept**: application/pdf
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
### HTTP response details
|
|
350
|
-
| Status code | Description | Response headers |
|
|
351
|
-
|-------------|-------------|------------------|
|
|
352
|
-
|**200** | Order PDF | - |
|
|
353
|
-
|**400** | Bad Request | - |
|
|
354
|
-
|**401** | Unauthorised | - |
|
|
355
|
-
|**403** | Access Denied | - |
|
|
356
|
-
|
|
357
|
-
[[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)
|
|
358
|
-
|
|
359
178
|
# **getGetOrders**
|
|
360
179
|
> OrderSummariesModel getGetOrders()
|
|
361
180
|
|
|
@@ -428,64 +247,6 @@ No authorization required
|
|
|
428
247
|
|
|
429
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)
|
|
430
249
|
|
|
431
|
-
# **postAddOrderNote**
|
|
432
|
-
> postAddOrderNote()
|
|
433
|
-
|
|
434
|
-
Add Order Note
|
|
435
|
-
|
|
436
|
-
### Example
|
|
437
|
-
|
|
438
|
-
```typescript
|
|
439
|
-
import {
|
|
440
|
-
OrdersApi,
|
|
441
|
-
Configuration,
|
|
442
|
-
PostAddOrderNoteRequest
|
|
443
|
-
} from 'yellowgrid-api-ts';
|
|
444
|
-
|
|
445
|
-
const configuration = new Configuration();
|
|
446
|
-
const apiInstance = new OrdersApi(configuration);
|
|
447
|
-
|
|
448
|
-
let id: number; //Order ID (default to undefined)
|
|
449
|
-
let postAddOrderNoteRequest: PostAddOrderNoteRequest; // (optional)
|
|
450
|
-
|
|
451
|
-
const { status, data } = await apiInstance.postAddOrderNote(
|
|
452
|
-
id,
|
|
453
|
-
postAddOrderNoteRequest
|
|
454
|
-
);
|
|
455
|
-
```
|
|
456
|
-
|
|
457
|
-
### Parameters
|
|
458
|
-
|
|
459
|
-
|Name | Type | Description | Notes|
|
|
460
|
-
|------------- | ------------- | ------------- | -------------|
|
|
461
|
-
| **postAddOrderNoteRequest** | **PostAddOrderNoteRequest**| | |
|
|
462
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
### Return type
|
|
466
|
-
|
|
467
|
-
void (empty response body)
|
|
468
|
-
|
|
469
|
-
### Authorization
|
|
470
|
-
|
|
471
|
-
No authorization required
|
|
472
|
-
|
|
473
|
-
### HTTP request headers
|
|
474
|
-
|
|
475
|
-
- **Content-Type**: application/json
|
|
476
|
-
- **Accept**: Not defined
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
### HTTP response details
|
|
480
|
-
| Status code | Description | Response headers |
|
|
481
|
-
|-------------|-------------|------------------|
|
|
482
|
-
|**200** | No Response | - |
|
|
483
|
-
|**400** | Bad Request | - |
|
|
484
|
-
|**401** | Unauthorised | - |
|
|
485
|
-
|**403** | Access Denied | - |
|
|
486
|
-
|
|
487
|
-
[[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
|
-
|
|
489
250
|
# **postCreateAdminOrder**
|
|
490
251
|
> Array<OrderSummaryDTO> postCreateAdminOrder()
|
|
491
252
|
|
|
@@ -544,10 +305,10 @@ No authorization required
|
|
|
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
|
-
>
|
|
308
|
+
# **postGetOrders**
|
|
309
|
+
> Array<OrderSummaryDTO> postGetOrders()
|
|
549
310
|
|
|
550
|
-
Create
|
|
311
|
+
Create An Order (Beta)
|
|
551
312
|
|
|
552
313
|
### Example
|
|
553
314
|
|
|
@@ -555,20 +316,18 @@ Create Shipping Consignment
|
|
|
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
|
-
let
|
|
565
|
-
let
|
|
566
|
-
let shippingRequestDTO: ShippingRequestDTO; //Shipping Request (optional)
|
|
325
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
326
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
567
327
|
|
|
568
|
-
const { status, data } = await apiInstance.
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
shippingRequestDTO
|
|
328
|
+
const { status, data } = await apiInstance.postGetOrders(
|
|
329
|
+
readonly,
|
|
330
|
+
customerOrderRequestDTO
|
|
572
331
|
);
|
|
573
332
|
```
|
|
574
333
|
|
|
@@ -576,423 +335,13 @@ const { status, data } = await apiInstance.postCreateConsignment(
|
|
|
576
335
|
|
|
577
336
|
|Name | Type | Description | Notes|
|
|
578
337
|
|------------- | ------------- | ------------- | -------------|
|
|
579
|
-
| **
|
|
580
|
-
| **
|
|
581
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
338
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
339
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
582
340
|
|
|
583
341
|
|
|
584
342
|
### Return type
|
|
585
343
|
|
|
586
|
-
**
|
|
587
|
-
|
|
588
|
-
### Authorization
|
|
589
|
-
|
|
590
|
-
No authorization required
|
|
591
|
-
|
|
592
|
-
### HTTP request headers
|
|
593
|
-
|
|
594
|
-
- **Content-Type**: application/json
|
|
595
|
-
- **Accept**: application/json
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
### HTTP response details
|
|
599
|
-
| Status code | Description | Response headers |
|
|
600
|
-
|-------------|-------------|------------------|
|
|
601
|
-
|**200** | Shipping Information | - |
|
|
602
|
-
|**400** | Bad Request | - |
|
|
603
|
-
|**401** | Unauthorised | - |
|
|
604
|
-
|**403** | Access Denied | - |
|
|
605
|
-
|
|
606
|
-
[[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)
|
|
607
|
-
|
|
608
|
-
# **postCreateShipment**
|
|
609
|
-
> ShipmentModel postCreateShipment()
|
|
610
|
-
|
|
611
|
-
Create Shipment (Admin)
|
|
612
|
-
|
|
613
|
-
### Example
|
|
614
|
-
|
|
615
|
-
```typescript
|
|
616
|
-
import {
|
|
617
|
-
OrdersApi,
|
|
618
|
-
Configuration,
|
|
619
|
-
ShipmentRequestDTO
|
|
620
|
-
} from 'yellowgrid-api-ts';
|
|
621
|
-
|
|
622
|
-
const configuration = new Configuration();
|
|
623
|
-
const apiInstance = new OrdersApi(configuration);
|
|
624
|
-
|
|
625
|
-
let id: number; //Order ID (default to undefined)
|
|
626
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
627
|
-
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
628
|
-
|
|
629
|
-
const { status, data } = await apiInstance.postCreateShipment(
|
|
630
|
-
id,
|
|
631
|
-
batchId,
|
|
632
|
-
shipmentRequestDTO
|
|
633
|
-
);
|
|
634
|
-
```
|
|
635
|
-
|
|
636
|
-
### Parameters
|
|
637
|
-
|
|
638
|
-
|Name | Type | Description | Notes|
|
|
639
|
-
|------------- | ------------- | ------------- | -------------|
|
|
640
|
-
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
641
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
642
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
### Return type
|
|
646
|
-
|
|
647
|
-
**ShipmentModel**
|
|
648
|
-
|
|
649
|
-
### Authorization
|
|
650
|
-
|
|
651
|
-
No authorization required
|
|
652
|
-
|
|
653
|
-
### HTTP request headers
|
|
654
|
-
|
|
655
|
-
- **Content-Type**: application/json
|
|
656
|
-
- **Accept**: application/json
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
### HTTP response details
|
|
660
|
-
| Status code | Description | Response headers |
|
|
661
|
-
|-------------|-------------|------------------|
|
|
662
|
-
|**200** | Shipment | - |
|
|
663
|
-
|**400** | Bad Request | - |
|
|
664
|
-
|**401** | Unauthorised | - |
|
|
665
|
-
|**403** | Access Denied | - |
|
|
666
|
-
|
|
667
|
-
[[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)
|
|
668
|
-
|
|
669
|
-
# **postGetOrders**
|
|
670
|
-
> Array<OrderSummaryDTO> postGetOrders()
|
|
671
|
-
|
|
672
|
-
Create An Order (Beta)
|
|
673
|
-
|
|
674
|
-
### Example
|
|
675
|
-
|
|
676
|
-
```typescript
|
|
677
|
-
import {
|
|
678
|
-
OrdersApi,
|
|
679
|
-
Configuration,
|
|
680
|
-
CustomerOrderRequestDTO
|
|
681
|
-
} from 'yellowgrid-api-ts';
|
|
682
|
-
|
|
683
|
-
const configuration = new Configuration();
|
|
684
|
-
const apiInstance = new OrdersApi(configuration);
|
|
685
|
-
|
|
686
|
-
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
687
|
-
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
688
|
-
|
|
689
|
-
const { status, data } = await apiInstance.postGetOrders(
|
|
690
|
-
readonly,
|
|
691
|
-
customerOrderRequestDTO
|
|
692
|
-
);
|
|
693
|
-
```
|
|
694
|
-
|
|
695
|
-
### Parameters
|
|
696
|
-
|
|
697
|
-
|Name | Type | Description | Notes|
|
|
698
|
-
|------------- | ------------- | ------------- | -------------|
|
|
699
|
-
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
700
|
-
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
### Return type
|
|
704
|
-
|
|
705
|
-
**Array<OrderSummaryDTO>**
|
|
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** | Order Summaries | - |
|
|
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
|
-
# **postIssueCredit**
|
|
728
|
-
> CreditNoteModel postIssueCredit()
|
|
729
|
-
|
|
730
|
-
Issue Credit (Admin)
|
|
731
|
-
|
|
732
|
-
### Example
|
|
733
|
-
|
|
734
|
-
```typescript
|
|
735
|
-
import {
|
|
736
|
-
OrdersApi,
|
|
737
|
-
Configuration,
|
|
738
|
-
CreditNoteDTO
|
|
739
|
-
} from 'yellowgrid-api-ts';
|
|
740
|
-
|
|
741
|
-
const configuration = new Configuration();
|
|
742
|
-
const apiInstance = new OrdersApi(configuration);
|
|
743
|
-
|
|
744
|
-
let id: number; //Order ID (default to undefined)
|
|
745
|
-
let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
|
|
746
|
-
|
|
747
|
-
const { status, data } = await apiInstance.postIssueCredit(
|
|
748
|
-
id,
|
|
749
|
-
creditNoteDTO
|
|
750
|
-
);
|
|
751
|
-
```
|
|
752
|
-
|
|
753
|
-
### Parameters
|
|
754
|
-
|
|
755
|
-
|Name | Type | Description | Notes|
|
|
756
|
-
|------------- | ------------- | ------------- | -------------|
|
|
757
|
-
| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
|
|
758
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
### Return type
|
|
762
|
-
|
|
763
|
-
**CreditNoteModel**
|
|
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** | Credit Note | - |
|
|
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
|
-
# **postPrintShippingLabel**
|
|
786
|
-
> File postPrintShippingLabel()
|
|
787
|
-
|
|
788
|
-
Print Shipment Label
|
|
789
|
-
|
|
790
|
-
### Example
|
|
791
|
-
|
|
792
|
-
```typescript
|
|
793
|
-
import {
|
|
794
|
-
OrdersApi,
|
|
795
|
-
Configuration
|
|
796
|
-
} from 'yellowgrid-api-ts';
|
|
797
|
-
|
|
798
|
-
const configuration = new Configuration();
|
|
799
|
-
const apiInstance = new OrdersApi(configuration);
|
|
800
|
-
|
|
801
|
-
let id: number; //Order ID (default to undefined)
|
|
802
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
803
|
-
let printer: 1 | 2 | 3; //Printer (default to undefined)
|
|
804
|
-
|
|
805
|
-
const { status, data } = await apiInstance.postPrintShippingLabel(
|
|
806
|
-
id,
|
|
807
|
-
shipmentId,
|
|
808
|
-
printer
|
|
809
|
-
);
|
|
810
|
-
```
|
|
811
|
-
|
|
812
|
-
### Parameters
|
|
813
|
-
|
|
814
|
-
|Name | Type | Description | Notes|
|
|
815
|
-
|------------- | ------------- | ------------- | -------------|
|
|
816
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
817
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
818
|
-
| **printer** | [**1 | 2 | 3**]**Array<1 | 2 | 3>** | Printer | defaults to undefined|
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
### Return type
|
|
822
|
-
|
|
823
|
-
**File**
|
|
824
|
-
|
|
825
|
-
### Authorization
|
|
826
|
-
|
|
827
|
-
No authorization required
|
|
828
|
-
|
|
829
|
-
### HTTP request headers
|
|
830
|
-
|
|
831
|
-
- **Content-Type**: Not defined
|
|
832
|
-
- **Accept**: text/html, application/json
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
### HTTP response details
|
|
836
|
-
| Status code | Description | Response headers |
|
|
837
|
-
|-------------|-------------|------------------|
|
|
838
|
-
|**200** | Shipping Label | - |
|
|
839
|
-
|**400** | Bad Request | - |
|
|
840
|
-
|**401** | Unauthorised | - |
|
|
841
|
-
|**403** | Access Denied | - |
|
|
842
|
-
|
|
843
|
-
[[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)
|
|
844
|
-
|
|
845
|
-
# **postSendOrderEmail**
|
|
846
|
-
> postSendOrderEmail()
|
|
847
|
-
|
|
848
|
-
Send Order Email
|
|
849
|
-
|
|
850
|
-
### Example
|
|
851
|
-
|
|
852
|
-
```typescript
|
|
853
|
-
import {
|
|
854
|
-
OrdersApi,
|
|
855
|
-
Configuration
|
|
856
|
-
} from 'yellowgrid-api-ts';
|
|
857
|
-
|
|
858
|
-
const configuration = new Configuration();
|
|
859
|
-
const apiInstance = new OrdersApi(configuration);
|
|
860
|
-
|
|
861
|
-
let id: number; //Order ID (default to undefined)
|
|
862
|
-
let email: string; //Email Address (default to undefined)
|
|
863
|
-
|
|
864
|
-
const { status, data } = await apiInstance.postSendOrderEmail(
|
|
865
|
-
id,
|
|
866
|
-
email
|
|
867
|
-
);
|
|
868
|
-
```
|
|
869
|
-
|
|
870
|
-
### Parameters
|
|
871
|
-
|
|
872
|
-
|Name | Type | Description | Notes|
|
|
873
|
-
|------------- | ------------- | ------------- | -------------|
|
|
874
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
875
|
-
| **email** | [**string**] | Email Address | defaults to undefined|
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
### Return type
|
|
879
|
-
|
|
880
|
-
void (empty response body)
|
|
881
|
-
|
|
882
|
-
### Authorization
|
|
883
|
-
|
|
884
|
-
No authorization required
|
|
885
|
-
|
|
886
|
-
### HTTP request headers
|
|
887
|
-
|
|
888
|
-
- **Content-Type**: Not defined
|
|
889
|
-
- **Accept**: Not defined
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
### HTTP response details
|
|
893
|
-
| Status code | Description | Response headers |
|
|
894
|
-
|-------------|-------------|------------------|
|
|
895
|
-
|**200** | No Response | - |
|
|
896
|
-
|**400** | Bad Request | - |
|
|
897
|
-
|**401** | Unauthorised | - |
|
|
898
|
-
|**403** | Access Denied | - |
|
|
899
|
-
|
|
900
|
-
[[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)
|
|
901
|
-
|
|
902
|
-
# **postSendSupplierEmail**
|
|
903
|
-
> postSendSupplierEmail()
|
|
904
|
-
|
|
905
|
-
Send Supplier Email
|
|
906
|
-
|
|
907
|
-
### Example
|
|
908
|
-
|
|
909
|
-
```typescript
|
|
910
|
-
import {
|
|
911
|
-
OrdersApi,
|
|
912
|
-
Configuration
|
|
913
|
-
} from 'yellowgrid-api-ts';
|
|
914
|
-
|
|
915
|
-
const configuration = new Configuration();
|
|
916
|
-
const apiInstance = new OrdersApi(configuration);
|
|
917
|
-
|
|
918
|
-
let id: number; //Order ID (default to undefined)
|
|
919
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
920
|
-
|
|
921
|
-
const { status, data } = await apiInstance.postSendSupplierEmail(
|
|
922
|
-
id,
|
|
923
|
-
batchId
|
|
924
|
-
);
|
|
925
|
-
```
|
|
926
|
-
|
|
927
|
-
### Parameters
|
|
928
|
-
|
|
929
|
-
|Name | Type | Description | Notes|
|
|
930
|
-
|------------- | ------------- | ------------- | -------------|
|
|
931
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
932
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
### Return type
|
|
936
|
-
|
|
937
|
-
void (empty response body)
|
|
938
|
-
|
|
939
|
-
### Authorization
|
|
940
|
-
|
|
941
|
-
No authorization required
|
|
942
|
-
|
|
943
|
-
### HTTP request headers
|
|
944
|
-
|
|
945
|
-
- **Content-Type**: Not defined
|
|
946
|
-
- **Accept**: Not defined
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
### HTTP response details
|
|
950
|
-
| Status code | Description | Response headers |
|
|
951
|
-
|-------------|-------------|------------------|
|
|
952
|
-
|**200** | No Response | - |
|
|
953
|
-
|**400** | Bad Request | - |
|
|
954
|
-
|**401** | Unauthorised | - |
|
|
955
|
-
|**403** | Access Denied | - |
|
|
956
|
-
|
|
957
|
-
[[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)
|
|
958
|
-
|
|
959
|
-
# **postSplitOrder**
|
|
960
|
-
> Array<OrderSummaryDTO> postSplitOrder()
|
|
961
|
-
|
|
962
|
-
Split Order
|
|
963
|
-
|
|
964
|
-
### Example
|
|
965
|
-
|
|
966
|
-
```typescript
|
|
967
|
-
import {
|
|
968
|
-
OrdersApi,
|
|
969
|
-
Configuration,
|
|
970
|
-
PostSplitOrderRequest
|
|
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 postSplitOrderRequest: PostSplitOrderRequest; // (optional)
|
|
978
|
-
|
|
979
|
-
const { status, data } = await apiInstance.postSplitOrder(
|
|
980
|
-
id,
|
|
981
|
-
postSplitOrderRequest
|
|
982
|
-
);
|
|
983
|
-
```
|
|
984
|
-
|
|
985
|
-
### Parameters
|
|
986
|
-
|
|
987
|
-
|Name | Type | Description | Notes|
|
|
988
|
-
|------------- | ------------- | ------------- | -------------|
|
|
989
|
-
| **postSplitOrderRequest** | **PostSplitOrderRequest**| | |
|
|
990
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
### Return type
|
|
994
|
-
|
|
995
|
-
**Array<OrderSummaryDTO>**
|
|
344
|
+
**Array<OrderSummaryDTO>**
|
|
996
345
|
|
|
997
346
|
### Authorization
|
|
998
347
|
|
|
@@ -1014,131 +363,6 @@ No authorization required
|
|
|
1014
363
|
|
|
1015
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)
|
|
1016
365
|
|
|
1017
|
-
# **putAllocateItems**
|
|
1018
|
-
> putAllocateItems()
|
|
1019
|
-
|
|
1020
|
-
Allocate Items To Supplier
|
|
1021
|
-
|
|
1022
|
-
### Example
|
|
1023
|
-
|
|
1024
|
-
```typescript
|
|
1025
|
-
import {
|
|
1026
|
-
OrdersApi,
|
|
1027
|
-
Configuration,
|
|
1028
|
-
PutAllocateItemsRequest
|
|
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 supplierId: number; //Supplier ID (default to undefined)
|
|
1036
|
-
let putAllocateItemsRequest: PutAllocateItemsRequest; // (optional)
|
|
1037
|
-
|
|
1038
|
-
const { status, data } = await apiInstance.putAllocateItems(
|
|
1039
|
-
id,
|
|
1040
|
-
supplierId,
|
|
1041
|
-
putAllocateItemsRequest
|
|
1042
|
-
);
|
|
1043
|
-
```
|
|
1044
|
-
|
|
1045
|
-
### Parameters
|
|
1046
|
-
|
|
1047
|
-
|Name | Type | Description | Notes|
|
|
1048
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1049
|
-
| **putAllocateItemsRequest** | **PutAllocateItemsRequest**| | |
|
|
1050
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1051
|
-
| **supplierId** | [**number**] | Supplier ID | defaults to undefined|
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
### Return type
|
|
1055
|
-
|
|
1056
|
-
void (empty response body)
|
|
1057
|
-
|
|
1058
|
-
### Authorization
|
|
1059
|
-
|
|
1060
|
-
No authorization required
|
|
1061
|
-
|
|
1062
|
-
### HTTP request headers
|
|
1063
|
-
|
|
1064
|
-
- **Content-Type**: application/json
|
|
1065
|
-
- **Accept**: Not defined
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
### HTTP response details
|
|
1069
|
-
| Status code | Description | Response headers |
|
|
1070
|
-
|-------------|-------------|------------------|
|
|
1071
|
-
|**200** | No Response | - |
|
|
1072
|
-
|**400** | Bad Request | - |
|
|
1073
|
-
|**401** | Unauthorised | - |
|
|
1074
|
-
|**403** | Access Denied | - |
|
|
1075
|
-
|
|
1076
|
-
[[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)
|
|
1077
|
-
|
|
1078
|
-
# **putCreateShipment**
|
|
1079
|
-
> ShipmentModel putCreateShipment()
|
|
1080
|
-
|
|
1081
|
-
Update Shipment (Admin)
|
|
1082
|
-
|
|
1083
|
-
### Example
|
|
1084
|
-
|
|
1085
|
-
```typescript
|
|
1086
|
-
import {
|
|
1087
|
-
OrdersApi,
|
|
1088
|
-
Configuration,
|
|
1089
|
-
ShipmentRequestDTO
|
|
1090
|
-
} from 'yellowgrid-api-ts';
|
|
1091
|
-
|
|
1092
|
-
const configuration = new Configuration();
|
|
1093
|
-
const apiInstance = new OrdersApi(configuration);
|
|
1094
|
-
|
|
1095
|
-
let id: number; //Order ID (default to undefined)
|
|
1096
|
-
let batchId: number; //Batch ID (default to undefined)
|
|
1097
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
1098
|
-
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
1099
|
-
|
|
1100
|
-
const { status, data } = await apiInstance.putCreateShipment(
|
|
1101
|
-
id,
|
|
1102
|
-
batchId,
|
|
1103
|
-
shipmentId,
|
|
1104
|
-
shipmentRequestDTO
|
|
1105
|
-
);
|
|
1106
|
-
```
|
|
1107
|
-
|
|
1108
|
-
### Parameters
|
|
1109
|
-
|
|
1110
|
-
|Name | Type | Description | Notes|
|
|
1111
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1112
|
-
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
1113
|
-
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1114
|
-
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1115
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
### Return type
|
|
1119
|
-
|
|
1120
|
-
**ShipmentModel**
|
|
1121
|
-
|
|
1122
|
-
### Authorization
|
|
1123
|
-
|
|
1124
|
-
No authorization required
|
|
1125
|
-
|
|
1126
|
-
### HTTP request headers
|
|
1127
|
-
|
|
1128
|
-
- **Content-Type**: application/json
|
|
1129
|
-
- **Accept**: application/json
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
### HTTP response details
|
|
1133
|
-
| Status code | Description | Response headers |
|
|
1134
|
-
|-------------|-------------|------------------|
|
|
1135
|
-
|**200** | Shipment | - |
|
|
1136
|
-
|**400** | Bad Request | - |
|
|
1137
|
-
|**401** | Unauthorised | - |
|
|
1138
|
-
|**403** | Access Denied | - |
|
|
1139
|
-
|
|
1140
|
-
[[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)
|
|
1141
|
-
|
|
1142
366
|
# **putUpdateAdminOrder**
|
|
1143
367
|
> Array<OrderSummaryDTO> putUpdateAdminOrder()
|
|
1144
368
|
|