yellowgrid-api-ts 3.2.61-dev.0 → 3.2.61

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.
Files changed (69) hide show
  1. package/.openapi-generator/FILES +229 -249
  2. package/README.md +1 -36
  3. package/api.ts +212 -2463
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/config.json +3 -3
  7. package/configuration.ts +1 -1
  8. package/dist/api.d.ts +104 -1769
  9. package/dist/api.js +94 -1480
  10. package/dist/base.d.ts +1 -1
  11. package/dist/base.js +2 -2
  12. package/dist/common.d.ts +1 -1
  13. package/dist/common.js +1 -1
  14. package/dist/configuration.d.ts +1 -1
  15. package/dist/configuration.js +1 -1
  16. package/dist/index.d.ts +1 -1
  17. package/dist/index.js +1 -1
  18. package/docs/AccountsApi.md +1 -1
  19. package/docs/CRMApi.md +1 -1
  20. package/docs/Class3CXApi.md +1 -1
  21. package/docs/Class3CXInstallationWizardApi.md +1 -1
  22. package/docs/Class3CXInstallationsApi.md +1 -1
  23. package/docs/Class3CXIntegrationsApi.md +1 -1
  24. package/docs/Class3CXMultiTenantApi.md +1 -1
  25. package/docs/MyPBXToolsApi.md +1 -1
  26. package/docs/OAuth20Api.md +1 -1
  27. package/docs/OrdersApi.md +23 -861
  28. package/docs/PricingApi.md +1 -1
  29. package/docs/ProductsApi.md +1 -1
  30. package/docs/ProvisioningApi.md +1 -1
  31. package/docs/SIPTrunksApi.md +1 -1
  32. package/docs/SMSApi.md +1 -1
  33. package/docs/ServicesApi.md +1 -1
  34. package/docs/ShippingApi.md +1 -1
  35. package/docs/StockManagementApi.md +1 -1
  36. package/docs/SystemApi.md +1 -1
  37. package/docs/TicketsApi.md +1 -1
  38. package/docs/WebhooksApi.md +1 -1
  39. package/getEnums.php +31 -31
  40. package/index.ts +1 -1
  41. package/package.json +1 -1
  42. package/dist/models/CourierEnum.d.ts +0 -18
  43. package/dist/models/CourierEnum.js +0 -20
  44. package/dist/models/PrinterEnum.d.ts +0 -18
  45. package/dist/models/PrinterEnum.js +0 -20
  46. package/docs/BatchDTO.md +0 -59
  47. package/docs/CreditNoteDTO.md +0 -21
  48. package/docs/CreditNoteEntity.md +0 -29
  49. package/docs/CreditNoteItemDTO.md +0 -25
  50. package/docs/CreditNoteItemEntity.md +0 -29
  51. package/docs/CreditNoteModel.md +0 -29
  52. package/docs/OrderDetailsDTO.md +0 -63
  53. package/docs/OrderItemDTO.md +0 -53
  54. package/docs/OrderedItemModel.md +0 -47
  55. package/docs/PostAddOrderNoteRequest.md +0 -20
  56. package/docs/PostSplitOrderRequest.md +0 -20
  57. package/docs/PrinterEntity.md +0 -29
  58. package/docs/PutAllocateItemsRequest.md +0 -20
  59. package/docs/PutAllocateItemsRequestItemsInner.md +0 -22
  60. package/docs/ShipmentDTO.md +0 -31
  61. package/docs/ShipmentItemDTO.md +0 -23
  62. package/docs/ShipmentItemModel.md +0 -29
  63. package/docs/ShipmentModel.md +0 -43
  64. package/docs/ShipmentRequestDTO.md +0 -31
  65. package/docs/ShippingRequestDTO.md +0 -24
  66. package/docs/SupplierModel.md +0 -37
  67. package/hs_err_pid58424.log +0 -247
  68. package/models/CourierEnum.ts +0 -19
  69. package/models/PrinterEnum.ts +0 -19
package/docs/OrdersApi.md CHANGED
@@ -1,153 +1,18 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://api.yellowgrid.local*
3
+ All URIs are relative to *https://bitbucket.org*
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
- |[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
9
7
  |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
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
- |[**putCreateShipment**](#putcreateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments | Update Shipment (Admin)|
27
13
  |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
28
14
  |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
29
15
 
30
- # **deleteCreateShipment**
31
- > deleteCreateShipment()
32
-
33
- Delete Shipment (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
- let shipmentId: number; //Shipment ID (default to undefined)
49
-
50
- const { status, data } = await apiInstance.deleteCreateShipment(
51
- id,
52
- batchId,
53
- shipmentId
54
- );
55
- ```
56
-
57
- ### Parameters
58
-
59
- |Name | Type | Description | Notes|
60
- |------------- | ------------- | ------------- | -------------|
61
- | **id** | [**number**] | Order ID | defaults to undefined|
62
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
63
- | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
64
-
65
-
66
- ### Return type
67
-
68
- void (empty response body)
69
-
70
- ### Authorization
71
-
72
- No authorization required
73
-
74
- ### HTTP request headers
75
-
76
- - **Content-Type**: Not defined
77
- - **Accept**: Not defined
78
-
79
-
80
- ### HTTP response details
81
- | Status code | Description | Response headers |
82
- |-------------|-------------|------------------|
83
- |**200** | No Response | - |
84
- |**400** | Bad Request | - |
85
- |**401** | Unauthorised | - |
86
- |**403** | Access Denied | - |
87
-
88
- [[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)
89
-
90
- # **deleteDeleteBatch**
91
- > deleteDeleteBatch()
92
-
93
- Delete Batch (Admin)
94
-
95
- ### Example
96
-
97
- ```typescript
98
- import {
99
- OrdersApi,
100
- Configuration,
101
- ShipmentRequestDTO
102
- } from 'yellowgrid-api-ts';
103
-
104
- const configuration = new Configuration();
105
- const apiInstance = new OrdersApi(configuration);
106
-
107
- let id: number; //Order ID (default to undefined)
108
- let batchId: number; //Batch ID (default to undefined)
109
- let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
110
-
111
- const { status, data } = await apiInstance.deleteDeleteBatch(
112
- id,
113
- batchId,
114
- shipmentRequestDTO
115
- );
116
- ```
117
-
118
- ### Parameters
119
-
120
- |Name | Type | Description | Notes|
121
- |------------- | ------------- | ------------- | -------------|
122
- | **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
123
- | **id** | [**number**] | Order ID | defaults to undefined|
124
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
125
-
126
-
127
- ### Return type
128
-
129
- void (empty response body)
130
-
131
- ### Authorization
132
-
133
- No authorization required
134
-
135
- ### HTTP request headers
136
-
137
- - **Content-Type**: application/json
138
- - **Accept**: Not defined
139
-
140
-
141
- ### HTTP response details
142
- | Status code | Description | Response headers |
143
- |-------------|-------------|------------------|
144
- |**200** | No Response | - |
145
- |**400** | Bad Request | - |
146
- |**401** | Unauthorised | - |
147
- |**403** | Access Denied | - |
148
-
149
- [[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)
150
-
151
16
  # **deleteUpdateOrder**
152
17
  > deleteUpdateOrder()
153
18
 
@@ -256,60 +121,6 @@ No authorization required
256
121
 
257
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)
258
123
 
259
- # **getGetAdminOrderDetails**
260
- > OrderDetailsDTO getGetAdminOrderDetails()
261
-
262
- Get Order Details (Admin)
263
-
264
- ### Example
265
-
266
- ```typescript
267
- import {
268
- OrdersApi,
269
- Configuration
270
- } from 'yellowgrid-api-ts';
271
-
272
- const configuration = new Configuration();
273
- const apiInstance = new OrdersApi(configuration);
274
-
275
- let id: number; //Order ID (default to undefined)
276
-
277
- const { status, data } = await apiInstance.getGetAdminOrderDetails(
278
- id
279
- );
280
- ```
281
-
282
- ### Parameters
283
-
284
- |Name | Type | Description | Notes|
285
- |------------- | ------------- | ------------- | -------------|
286
- | **id** | [**number**] | Order ID | defaults to undefined|
287
-
288
-
289
- ### Return type
290
-
291
- **OrderDetailsDTO**
292
-
293
- ### Authorization
294
-
295
- No authorization required
296
-
297
- ### HTTP request headers
298
-
299
- - **Content-Type**: Not defined
300
- - **Accept**: application/json
301
-
302
-
303
- ### HTTP response details
304
- | Status code | Description | Response headers |
305
- |-------------|-------------|------------------|
306
- |**200** | Order Details | - |
307
- |**400** | Bad Request | - |
308
- |**401** | Unauthorised | - |
309
- |**403** | Access Denied | - |
310
-
311
- [[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)
312
-
313
124
  # **getGetEditableOrder**
314
125
  > DetailedOrderRequestDTO getGetEditableOrder()
315
126
 
@@ -364,60 +175,6 @@ No authorization required
364
175
 
365
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)
366
177
 
367
- # **getGetOrderPdf**
368
- > File getGetOrderPdf()
369
-
370
- Download Order PDF
371
-
372
- ### Example
373
-
374
- ```typescript
375
- import {
376
- OrdersApi,
377
- Configuration
378
- } from 'yellowgrid-api-ts';
379
-
380
- const configuration = new Configuration();
381
- const apiInstance = new OrdersApi(configuration);
382
-
383
- let id: number; //Order ID (default to undefined)
384
-
385
- const { status, data } = await apiInstance.getGetOrderPdf(
386
- id
387
- );
388
- ```
389
-
390
- ### Parameters
391
-
392
- |Name | Type | Description | Notes|
393
- |------------- | ------------- | ------------- | -------------|
394
- | **id** | [**number**] | Order ID | defaults to undefined|
395
-
396
-
397
- ### Return type
398
-
399
- **File**
400
-
401
- ### Authorization
402
-
403
- No authorization required
404
-
405
- ### HTTP request headers
406
-
407
- - **Content-Type**: Not defined
408
- - **Accept**: application/pdf
409
-
410
-
411
- ### HTTP response details
412
- | Status code | Description | Response headers |
413
- |-------------|-------------|------------------|
414
- |**200** | Order PDF | - |
415
- |**400** | Bad Request | - |
416
- |**401** | Unauthorised | - |
417
- |**403** | Access Denied | - |
418
-
419
- [[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)
420
-
421
178
  # **getGetOrders**
422
179
  > OrderSummariesModel getGetOrders()
423
180
 
@@ -490,10 +247,10 @@ No authorization required
490
247
 
491
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)
492
249
 
493
- # **postAddOrderNote**
494
- > postAddOrderNote()
250
+ # **postCreateAdminOrder**
251
+ > Array<OrderSummaryDTO> postCreateAdminOrder()
495
252
 
496
- Add Order Note
253
+ Create An Order (Admin)
497
254
 
498
255
  ### Example
499
256
 
@@ -501,18 +258,18 @@ Add Order Note
501
258
  import {
502
259
  OrdersApi,
503
260
  Configuration,
504
- PostAddOrderNoteRequest
261
+ AdminOrderRequestDTO
505
262
  } from 'yellowgrid-api-ts';
506
263
 
507
264
  const configuration = new Configuration();
508
265
  const apiInstance = new OrdersApi(configuration);
509
266
 
510
- let id: number; //Order ID (default to undefined)
511
- let postAddOrderNoteRequest: PostAddOrderNoteRequest; // (optional)
267
+ let readonly: boolean; //Readonly Order (optional) (default to undefined)
268
+ let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
512
269
 
513
- const { status, data } = await apiInstance.postAddOrderNote(
514
- id,
515
- postAddOrderNoteRequest
270
+ const { status, data } = await apiInstance.postCreateAdminOrder(
271
+ readonly,
272
+ adminOrderRequestDTO
516
273
  );
517
274
  ```
518
275
 
@@ -520,13 +277,13 @@ const { status, data } = await apiInstance.postAddOrderNote(
520
277
 
521
278
  |Name | Type | Description | Notes|
522
279
  |------------- | ------------- | ------------- | -------------|
523
- | **postAddOrderNoteRequest** | **PostAddOrderNoteRequest**| | |
524
- | **id** | [**number**] | Order ID | defaults to undefined|
280
+ | **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
281
+ | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
525
282
 
526
283
 
527
284
  ### Return type
528
285
 
529
- void (empty response body)
286
+ **Array<OrderSummaryDTO>**
530
287
 
531
288
  ### Authorization
532
289
 
@@ -535,23 +292,23 @@ No authorization required
535
292
  ### HTTP request headers
536
293
 
537
294
  - **Content-Type**: application/json
538
- - **Accept**: Not defined
295
+ - **Accept**: application/json
539
296
 
540
297
 
541
298
  ### HTTP response details
542
299
  | Status code | Description | Response headers |
543
300
  |-------------|-------------|------------------|
544
- |**200** | No Response | - |
301
+ |**200** | Order Summaries | - |
545
302
  |**400** | Bad Request | - |
546
303
  |**401** | Unauthorised | - |
547
304
  |**403** | Access Denied | - |
548
305
 
549
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)
550
307
 
551
- # **postCreateAdminOrder**
552
- > Array<OrderSummaryDTO> postCreateAdminOrder()
308
+ # **postGetOrders**
309
+ > Array<OrderSummaryDTO> postGetOrders()
553
310
 
554
- Create An Order (Admin)
311
+ Create An Order (Beta)
555
312
 
556
313
  ### Example
557
314
 
@@ -559,18 +316,18 @@ Create An Order (Admin)
559
316
  import {
560
317
  OrdersApi,
561
318
  Configuration,
562
- AdminOrderRequestDTO
319
+ CustomerOrderRequestDTO
563
320
  } from 'yellowgrid-api-ts';
564
321
 
565
322
  const configuration = new Configuration();
566
323
  const apiInstance = new OrdersApi(configuration);
567
324
 
568
325
  let readonly: boolean; //Readonly Order (optional) (default to undefined)
569
- let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
326
+ let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
570
327
 
571
- const { status, data } = await apiInstance.postCreateAdminOrder(
328
+ const { status, data } = await apiInstance.postGetOrders(
572
329
  readonly,
573
- adminOrderRequestDTO
330
+ customerOrderRequestDTO
574
331
  );
575
332
  ```
576
333
 
@@ -578,7 +335,7 @@ const { status, data } = await apiInstance.postCreateAdminOrder(
578
335
 
579
336
  |Name | Type | Description | Notes|
580
337
  |------------- | ------------- | ------------- | -------------|
581
- | **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
338
+ | **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
582
339
  | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
583
340
 
584
341
 
@@ -606,601 +363,6 @@ No authorization required
606
363
 
607
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)
608
365
 
609
- # **postCreateConsignment**
610
- > ShipmentModel postCreateConsignment()
611
-
612
- Create Shipping Consignment
613
-
614
- ### Example
615
-
616
- ```typescript
617
- import {
618
- OrdersApi,
619
- Configuration,
620
- ShippingRequestDTO
621
- } from 'yellowgrid-api-ts';
622
-
623
- const configuration = new Configuration();
624
- const apiInstance = new OrdersApi(configuration);
625
-
626
- let id: number; //Order ID (default to undefined)
627
- let shipmentId: number; //Shipment ID (default to undefined)
628
- let shippingRequestDTO: ShippingRequestDTO; //Shipping Request (optional)
629
-
630
- const { status, data } = await apiInstance.postCreateConsignment(
631
- id,
632
- shipmentId,
633
- shippingRequestDTO
634
- );
635
- ```
636
-
637
- ### Parameters
638
-
639
- |Name | Type | Description | Notes|
640
- |------------- | ------------- | ------------- | -------------|
641
- | **shippingRequestDTO** | **ShippingRequestDTO**| Shipping Request | |
642
- | **id** | [**number**] | Order ID | defaults to undefined|
643
- | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
644
-
645
-
646
- ### Return type
647
-
648
- **ShipmentModel**
649
-
650
- ### Authorization
651
-
652
- No authorization required
653
-
654
- ### HTTP request headers
655
-
656
- - **Content-Type**: application/json
657
- - **Accept**: application/json
658
-
659
-
660
- ### HTTP response details
661
- | Status code | Description | Response headers |
662
- |-------------|-------------|------------------|
663
- |**200** | Shipping Information | - |
664
- |**400** | Bad Request | - |
665
- |**401** | Unauthorised | - |
666
- |**403** | Access Denied | - |
667
-
668
- [[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)
669
-
670
- # **postCreateShipment**
671
- > ShipmentModel postCreateShipment()
672
-
673
- Create Shipment (Admin)
674
-
675
- ### Example
676
-
677
- ```typescript
678
- import {
679
- OrdersApi,
680
- Configuration,
681
- ShipmentRequestDTO
682
- } from 'yellowgrid-api-ts';
683
-
684
- const configuration = new Configuration();
685
- const apiInstance = new OrdersApi(configuration);
686
-
687
- let id: number; //Order ID (default to undefined)
688
- let batchId: number; //Batch ID (default to undefined)
689
- let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
690
-
691
- const { status, data } = await apiInstance.postCreateShipment(
692
- id,
693
- batchId,
694
- shipmentRequestDTO
695
- );
696
- ```
697
-
698
- ### Parameters
699
-
700
- |Name | Type | Description | Notes|
701
- |------------- | ------------- | ------------- | -------------|
702
- | **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
703
- | **id** | [**number**] | Order ID | defaults to undefined|
704
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
705
-
706
-
707
- ### Return type
708
-
709
- **ShipmentModel**
710
-
711
- ### Authorization
712
-
713
- No authorization required
714
-
715
- ### HTTP request headers
716
-
717
- - **Content-Type**: application/json
718
- - **Accept**: application/json
719
-
720
-
721
- ### HTTP response details
722
- | Status code | Description | Response headers |
723
- |-------------|-------------|------------------|
724
- |**200** | Shipment | - |
725
- |**400** | Bad Request | - |
726
- |**401** | Unauthorised | - |
727
- |**403** | Access Denied | - |
728
-
729
- [[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)
730
-
731
- # **postGetOrders**
732
- > Array<OrderSummaryDTO> postGetOrders()
733
-
734
- Create An Order (Beta)
735
-
736
- ### Example
737
-
738
- ```typescript
739
- import {
740
- OrdersApi,
741
- Configuration,
742
- CustomerOrderRequestDTO
743
- } from 'yellowgrid-api-ts';
744
-
745
- const configuration = new Configuration();
746
- const apiInstance = new OrdersApi(configuration);
747
-
748
- let readonly: boolean; //Readonly Order (optional) (default to undefined)
749
- let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
750
-
751
- const { status, data } = await apiInstance.postGetOrders(
752
- readonly,
753
- customerOrderRequestDTO
754
- );
755
- ```
756
-
757
- ### Parameters
758
-
759
- |Name | Type | Description | Notes|
760
- |------------- | ------------- | ------------- | -------------|
761
- | **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
762
- | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
763
-
764
-
765
- ### Return type
766
-
767
- **Array<OrderSummaryDTO>**
768
-
769
- ### Authorization
770
-
771
- No authorization required
772
-
773
- ### HTTP request headers
774
-
775
- - **Content-Type**: application/json
776
- - **Accept**: application/json
777
-
778
-
779
- ### HTTP response details
780
- | Status code | Description | Response headers |
781
- |-------------|-------------|------------------|
782
- |**200** | Order Summaries | - |
783
- |**400** | Bad Request | - |
784
- |**401** | Unauthorised | - |
785
- |**403** | Access Denied | - |
786
-
787
- [[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)
788
-
789
- # **postIssueCredit**
790
- > CreditNoteModel postIssueCredit()
791
-
792
- Issue Credit (Admin)
793
-
794
- ### Example
795
-
796
- ```typescript
797
- import {
798
- OrdersApi,
799
- Configuration,
800
- CreditNoteDTO
801
- } from 'yellowgrid-api-ts';
802
-
803
- const configuration = new Configuration();
804
- const apiInstance = new OrdersApi(configuration);
805
-
806
- let id: number; //Order ID (default to undefined)
807
- let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
808
-
809
- const { status, data } = await apiInstance.postIssueCredit(
810
- id,
811
- creditNoteDTO
812
- );
813
- ```
814
-
815
- ### Parameters
816
-
817
- |Name | Type | Description | Notes|
818
- |------------- | ------------- | ------------- | -------------|
819
- | **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
820
- | **id** | [**number**] | Order ID | defaults to undefined|
821
-
822
-
823
- ### Return type
824
-
825
- **CreditNoteModel**
826
-
827
- ### Authorization
828
-
829
- No authorization required
830
-
831
- ### HTTP request headers
832
-
833
- - **Content-Type**: application/json
834
- - **Accept**: application/json
835
-
836
-
837
- ### HTTP response details
838
- | Status code | Description | Response headers |
839
- |-------------|-------------|------------------|
840
- |**200** | Credit Note | - |
841
- |**400** | Bad Request | - |
842
- |**401** | Unauthorised | - |
843
- |**403** | Access Denied | - |
844
-
845
- [[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)
846
-
847
- # **postPrintShippingLabel**
848
- > File postPrintShippingLabel()
849
-
850
- Print Shipment Label
851
-
852
- ### Example
853
-
854
- ```typescript
855
- import {
856
- OrdersApi,
857
- Configuration
858
- } from 'yellowgrid-api-ts';
859
-
860
- const configuration = new Configuration();
861
- const apiInstance = new OrdersApi(configuration);
862
-
863
- let id: number; //Order ID (default to undefined)
864
- let shipmentId: number; //Shipment ID (default to undefined)
865
- let printer: 1 | 2 | 3; //Printer (default to undefined)
866
-
867
- const { status, data } = await apiInstance.postPrintShippingLabel(
868
- id,
869
- shipmentId,
870
- printer
871
- );
872
- ```
873
-
874
- ### Parameters
875
-
876
- |Name | Type | Description | Notes|
877
- |------------- | ------------- | ------------- | -------------|
878
- | **id** | [**number**] | Order ID | defaults to undefined|
879
- | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
880
- | **printer** | [**1 | 2 | 3**]**Array<1 &#124; 2 &#124; 3>** | Printer | defaults to undefined|
881
-
882
-
883
- ### Return type
884
-
885
- **File**
886
-
887
- ### Authorization
888
-
889
- No authorization required
890
-
891
- ### HTTP request headers
892
-
893
- - **Content-Type**: Not defined
894
- - **Accept**: text/html, application/json
895
-
896
-
897
- ### HTTP response details
898
- | Status code | Description | Response headers |
899
- |-------------|-------------|------------------|
900
- |**200** | Shipping Label | - |
901
- |**400** | Bad Request | - |
902
- |**401** | Unauthorised | - |
903
- |**403** | Access Denied | - |
904
-
905
- [[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)
906
-
907
- # **postSendOrderEmail**
908
- > postSendOrderEmail()
909
-
910
- Send Order Email
911
-
912
- ### Example
913
-
914
- ```typescript
915
- import {
916
- OrdersApi,
917
- Configuration
918
- } from 'yellowgrid-api-ts';
919
-
920
- const configuration = new Configuration();
921
- const apiInstance = new OrdersApi(configuration);
922
-
923
- let id: number; //Order ID (default to undefined)
924
- let email: string; //Email Address (default to undefined)
925
-
926
- const { status, data } = await apiInstance.postSendOrderEmail(
927
- id,
928
- email
929
- );
930
- ```
931
-
932
- ### Parameters
933
-
934
- |Name | Type | Description | Notes|
935
- |------------- | ------------- | ------------- | -------------|
936
- | **id** | [**number**] | Order ID | defaults to undefined|
937
- | **email** | [**string**] | Email Address | defaults to undefined|
938
-
939
-
940
- ### Return type
941
-
942
- void (empty response body)
943
-
944
- ### Authorization
945
-
946
- No authorization required
947
-
948
- ### HTTP request headers
949
-
950
- - **Content-Type**: Not defined
951
- - **Accept**: Not defined
952
-
953
-
954
- ### HTTP response details
955
- | Status code | Description | Response headers |
956
- |-------------|-------------|------------------|
957
- |**200** | No Response | - |
958
- |**400** | Bad Request | - |
959
- |**401** | Unauthorised | - |
960
- |**403** | Access Denied | - |
961
-
962
- [[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)
963
-
964
- # **postSendSupplierEmail**
965
- > postSendSupplierEmail()
966
-
967
- Send Supplier Email
968
-
969
- ### Example
970
-
971
- ```typescript
972
- import {
973
- OrdersApi,
974
- Configuration
975
- } from 'yellowgrid-api-ts';
976
-
977
- const configuration = new Configuration();
978
- const apiInstance = new OrdersApi(configuration);
979
-
980
- let id: number; //Order ID (default to undefined)
981
- let batchId: number; //Batch ID (default to undefined)
982
-
983
- const { status, data } = await apiInstance.postSendSupplierEmail(
984
- id,
985
- batchId
986
- );
987
- ```
988
-
989
- ### Parameters
990
-
991
- |Name | Type | Description | Notes|
992
- |------------- | ------------- | ------------- | -------------|
993
- | **id** | [**number**] | Order ID | defaults to undefined|
994
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
995
-
996
-
997
- ### Return type
998
-
999
- void (empty response body)
1000
-
1001
- ### Authorization
1002
-
1003
- No authorization required
1004
-
1005
- ### HTTP request headers
1006
-
1007
- - **Content-Type**: Not defined
1008
- - **Accept**: Not defined
1009
-
1010
-
1011
- ### HTTP response details
1012
- | Status code | Description | Response headers |
1013
- |-------------|-------------|------------------|
1014
- |**200** | No Response | - |
1015
- |**400** | Bad Request | - |
1016
- |**401** | Unauthorised | - |
1017
- |**403** | Access Denied | - |
1018
-
1019
- [[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)
1020
-
1021
- # **postSplitOrder**
1022
- > Array<OrderSummaryDTO> postSplitOrder()
1023
-
1024
- Split Order
1025
-
1026
- ### Example
1027
-
1028
- ```typescript
1029
- import {
1030
- OrdersApi,
1031
- Configuration,
1032
- PostSplitOrderRequest
1033
- } from 'yellowgrid-api-ts';
1034
-
1035
- const configuration = new Configuration();
1036
- const apiInstance = new OrdersApi(configuration);
1037
-
1038
- let id: number; //Order ID (default to undefined)
1039
- let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
1040
-
1041
- const { status, data } = await apiInstance.postSplitOrder(
1042
- id,
1043
- postSplitOrderRequest
1044
- );
1045
- ```
1046
-
1047
- ### Parameters
1048
-
1049
- |Name | Type | Description | Notes|
1050
- |------------- | ------------- | ------------- | -------------|
1051
- | **postSplitOrderRequest** | **PostSplitOrderRequest**| | |
1052
- | **id** | [**number**] | Order ID | defaults to undefined|
1053
-
1054
-
1055
- ### Return type
1056
-
1057
- **Array<OrderSummaryDTO>**
1058
-
1059
- ### Authorization
1060
-
1061
- No authorization required
1062
-
1063
- ### HTTP request headers
1064
-
1065
- - **Content-Type**: application/json
1066
- - **Accept**: application/json
1067
-
1068
-
1069
- ### HTTP response details
1070
- | Status code | Description | Response headers |
1071
- |-------------|-------------|------------------|
1072
- |**200** | Order Summaries | - |
1073
- |**400** | Bad Request | - |
1074
- |**401** | Unauthorised | - |
1075
- |**403** | Access Denied | - |
1076
-
1077
- [[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)
1078
-
1079
- # **putAllocateItems**
1080
- > putAllocateItems()
1081
-
1082
- Allocate Items To Supplier
1083
-
1084
- ### Example
1085
-
1086
- ```typescript
1087
- import {
1088
- OrdersApi,
1089
- Configuration,
1090
- PutAllocateItemsRequest
1091
- } from 'yellowgrid-api-ts';
1092
-
1093
- const configuration = new Configuration();
1094
- const apiInstance = new OrdersApi(configuration);
1095
-
1096
- let id: number; //Order ID (default to undefined)
1097
- let supplierId: number; //Supplier ID (default to undefined)
1098
- let putAllocateItemsRequest: PutAllocateItemsRequest; // (optional)
1099
-
1100
- const { status, data } = await apiInstance.putAllocateItems(
1101
- id,
1102
- supplierId,
1103
- putAllocateItemsRequest
1104
- );
1105
- ```
1106
-
1107
- ### Parameters
1108
-
1109
- |Name | Type | Description | Notes|
1110
- |------------- | ------------- | ------------- | -------------|
1111
- | **putAllocateItemsRequest** | **PutAllocateItemsRequest**| | |
1112
- | **id** | [**number**] | Order ID | defaults to undefined|
1113
- | **supplierId** | [**number**] | Supplier ID | defaults to undefined|
1114
-
1115
-
1116
- ### Return type
1117
-
1118
- void (empty response body)
1119
-
1120
- ### Authorization
1121
-
1122
- No authorization required
1123
-
1124
- ### HTTP request headers
1125
-
1126
- - **Content-Type**: application/json
1127
- - **Accept**: Not defined
1128
-
1129
-
1130
- ### HTTP response details
1131
- | Status code | Description | Response headers |
1132
- |-------------|-------------|------------------|
1133
- |**200** | No Response | - |
1134
- |**400** | Bad Request | - |
1135
- |**401** | Unauthorised | - |
1136
- |**403** | Access Denied | - |
1137
-
1138
- [[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)
1139
-
1140
- # **putCreateShipment**
1141
- > ShipmentModel putCreateShipment()
1142
-
1143
- Update Shipment (Admin)
1144
-
1145
- ### Example
1146
-
1147
- ```typescript
1148
- import {
1149
- OrdersApi,
1150
- Configuration,
1151
- ShipmentRequestDTO
1152
- } from 'yellowgrid-api-ts';
1153
-
1154
- const configuration = new Configuration();
1155
- const apiInstance = new OrdersApi(configuration);
1156
-
1157
- let id: number; //Order ID (default to undefined)
1158
- let batchId: number; //Batch ID (default to undefined)
1159
- let shipmentId: number; //Shipment ID (default to undefined)
1160
- let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
1161
-
1162
- const { status, data } = await apiInstance.putCreateShipment(
1163
- id,
1164
- batchId,
1165
- shipmentId,
1166
- shipmentRequestDTO
1167
- );
1168
- ```
1169
-
1170
- ### Parameters
1171
-
1172
- |Name | Type | Description | Notes|
1173
- |------------- | ------------- | ------------- | -------------|
1174
- | **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
1175
- | **id** | [**number**] | Order ID | defaults to undefined|
1176
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
1177
- | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
1178
-
1179
-
1180
- ### Return type
1181
-
1182
- **ShipmentModel**
1183
-
1184
- ### Authorization
1185
-
1186
- No authorization required
1187
-
1188
- ### HTTP request headers
1189
-
1190
- - **Content-Type**: application/json
1191
- - **Accept**: application/json
1192
-
1193
-
1194
- ### HTTP response details
1195
- | Status code | Description | Response headers |
1196
- |-------------|-------------|------------------|
1197
- |**200** | Shipment | - |
1198
- |**400** | Bad Request | - |
1199
- |**401** | Unauthorised | - |
1200
- |**403** | Access Denied | - |
1201
-
1202
- [[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)
1203
-
1204
366
  # **putUpdateAdminOrder**
1205
367
  > Array<OrderSummaryDTO> putUpdateAdminOrder()
1206
368