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

package/docs/OrdersApi.md

@@ -1,149 +1,18 @@
 # OrdersApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
-|[**deleteDeleteShipment**](#deletedeleteshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
 |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
-|[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
-|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
 |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
-|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
 |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
-|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
-|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
-|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
-|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
-|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
-|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
-|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
-|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
-|[**putCreateShipment**](#putcreateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments | Update Shipment (Admin)|
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
 |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
 
-# **deleteDeleteBatch**
-> deleteDeleteBatch()
-
-Delete Batch (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-
-const { status, data } = await apiInstance.deleteDeleteBatch(
-    id,
-    batchId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **deleteDeleteShipment**
-> deleteDeleteShipment()
-
-Delete Shipment (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-let shipmentId: number; //Shipment ID (default to undefined)
-
-const { status, data } = await apiInstance.deleteDeleteShipment(
-    id,
-    batchId,
-    shipmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
 # **deleteUpdateOrder**
 > deleteUpdateOrder()
 
@@ -252,60 +121,6 @@ No authorization required
 
 [[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)
 
-# **getGetAdminOrderDetails**
-> OrderDetailsDTO getGetAdminOrderDetails()
-
-Get Order Details (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetAdminOrderDetails(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-
-
-### Return type
-
-**OrderDetailsDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order Details |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
 # **getGetEditableOrder**
 > DetailedOrderRequestDTO getGetEditableOrder()
 
@@ -360,60 +175,6 @@ No authorization required
 
 [[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)
 
-# **getGetOrderPdf**
-> File getGetOrderPdf()
-
-Download Order PDF
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetOrderPdf(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-
-
-### Return type
-
-**File**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/pdf
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order PDF |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
 # **getGetOrders**
 > OrderSummariesModel getGetOrders()
 
@@ -486,10 +247,10 @@ No authorization required
 
 [[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)
 
-# **postAddOrderNote**
-> AuditLogEntity postAddOrderNote()
+# **postCreateAdminOrder**
+> Array<OrderSummaryDTO> postCreateAdminOrder()
 
-Add Order Note
+Create An Order (Admin)
 
 ### Example
 
@@ -497,18 +258,18 @@ Add Order Note
 import {
     OrdersApi,
     Configuration,
-    PostAddOrderNoteRequest
+    AdminOrderRequestDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let id: number; //Order ID (default to undefined)
-let postAddOrderNoteRequest: PostAddOrderNoteRequest; // (optional)
+let readonly: boolean; //Readonly Order (optional) (default to undefined)
+let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
 
-const { status, data } = await apiInstance.postAddOrderNote(
-    id,
-    postAddOrderNoteRequest
+const { status, data } = await apiInstance.postCreateAdminOrder(
+    readonly,
+    adminOrderRequestDTO
 );
 ```
 
@@ -516,13 +277,13 @@ const { status, data } = await apiInstance.postAddOrderNote(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postAddOrderNoteRequest** | **PostAddOrderNoteRequest**|  | |
-| **id** | [**number**] | Order ID | defaults to undefined|
+| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
+| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
 
 
 ### Return type
 
-**AuditLogEntity**
+**Array<OrderSummaryDTO>**
 
 ### Authorization
 
@@ -537,17 +298,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Audit Log Entry |  -  |
+|**200** | Order Summaries |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
 
 [[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)
 
-# **postCreateAdminOrder**
-> Array<OrderSummaryDTO> postCreateAdminOrder()
+# **postGetOrders**
+> Array<OrderSummaryDTO> postGetOrders()
 
-Create An Order (Admin)
+Create An Order (Beta)
 
 ### Example
 
@@ -555,18 +316,18 @@ Create An Order (Admin)
 import {
     OrdersApi,
     Configuration,
-    AdminOrderRequestDTO
+    CustomerOrderRequestDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
+let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
 
-const { status, data } = await apiInstance.postCreateAdminOrder(
+const { status, data } = await apiInstance.postGetOrders(
     readonly,
-    adminOrderRequestDTO
+    customerOrderRequestDTO
 );
 ```
 
@@ -574,7 +335,7 @@ const { status, data } = await apiInstance.postCreateAdminOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
+| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
 | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
 
 
@@ -602,601 +363,6 @@ No authorization required
 
 [[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)
 
-# **postCreateConsignment**
-> ShipmentModel postCreateConsignment()
-
-Create Shipping Consignment
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    ShippingRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let shipmentId: number; //Shipment ID (default to undefined)
-let shippingRequestDTO: ShippingRequestDTO; //Shipping Request (optional)
-
-const { status, data } = await apiInstance.postCreateConsignment(
-    id,
-    shipmentId,
-    shippingRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **shippingRequestDTO** | **ShippingRequestDTO**| Shipping Request | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
-
-
-### Return type
-
-**ShipmentModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Shipping Information |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postCreateShipment**
-> ShipmentDTO postCreateShipment()
-
-Create Shipment (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    ShipmentRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
-
-const { status, data } = await apiInstance.postCreateShipment(
-    id,
-    batchId,
-    shipmentRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-
-
-### Return type
-
-**ShipmentDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Shipment |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postGetOrders**
-> Array<OrderSummaryDTO> postGetOrders()
-
-Create An Order (Beta)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    CustomerOrderRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
-
-const { status, data } = await apiInstance.postGetOrders(
-    readonly,
-    customerOrderRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<OrderSummaryDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order Summaries |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postIssueCredit**
-> CreditNoteModel postIssueCredit()
-
-Issue Credit (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    CreditNoteDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
-
-const { status, data } = await apiInstance.postIssueCredit(
-    id,
-    creditNoteDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-
-
-### Return type
-
-**CreditNoteModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Credit Note |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postPrintShippingLabel**
-> File postPrintShippingLabel()
-
-Print Shipment Label
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let shipmentId: number; //Shipment ID (default to undefined)
-let printer: 1 | 2 | 3; //Printer (default to undefined)
-
-const { status, data } = await apiInstance.postPrintShippingLabel(
-    id,
-    shipmentId,
-    printer
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
-| **printer** | [**1 | 2 | 3**]**Array<1 &#124; 2 &#124; 3>** | Printer | defaults to undefined|
-
-
-### Return type
-
-**File**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: text/html, application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Shipping Label |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postSendOrderEmail**
-> postSendOrderEmail()
-
-Send Order Email
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let email: string; //Email Address (default to undefined)
-
-const { status, data } = await apiInstance.postSendOrderEmail(
-    id,
-    email
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **email** | [**string**] | Email Address | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postSendSupplierEmail**
-> postSendSupplierEmail()
-
-Send Supplier Email
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-
-const { status, data } = await apiInstance.postSendSupplierEmail(
-    id,
-    batchId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postSplitOrder**
-> Array<OrderSummaryDTO> postSplitOrder()
-
-Split Order
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    PostSplitOrderRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
-
-const { status, data } = await apiInstance.postSplitOrder(
-    id,
-    postSplitOrderRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **postSplitOrderRequest** | **PostSplitOrderRequest**|  | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-
-
-### Return type
-
-**Array<OrderSummaryDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order Summaries |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **putAllocateItems**
-> Array<BatchDTO> putAllocateItems()
-
-Allocate Items To Supplier
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    PutAllocateItemsRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let supplierId: number; //Supplier ID (default to undefined)
-let putAllocateItemsRequest: PutAllocateItemsRequest; // (optional)
-
-const { status, data } = await apiInstance.putAllocateItems(
-    id,
-    supplierId,
-    putAllocateItemsRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **putAllocateItemsRequest** | **PutAllocateItemsRequest**|  | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **supplierId** | [**number**] | Supplier ID | defaults to undefined|
-
-
-### Return type
-
-**Array<BatchDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Order Batches |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **putCreateShipment**
-> ShipmentModel putCreateShipment()
-
-Update Shipment (Admin)
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    ShipmentRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-let shipmentId: number; //Shipment ID (default to undefined)
-let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
-
-const { status, data } = await apiInstance.putCreateShipment(
-    id,
-    batchId,
-    shipmentId,
-    shipmentRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
-| **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
-
-
-### Return type
-
-**ShipmentModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Shipment |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
 # **putUpdateAdminOrder**
 > Array<OrderSummaryDTO> putUpdateAdminOrder()