yellowgrid-api-ts 3.2.100-dev.0 → 3.2.102-dev.0

package/docs/OrdersApi.md

@@ -4,19 +4,1078 @@ All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
 |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
+|[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
+|[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
+|[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
+|[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
+|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
+|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
 |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
+|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
+|[**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|
+|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
+|[**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|
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
+|[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
 |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
+|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
+|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
+
+# **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)
 
 # **deleteUpdateOrder**
 > deleteUpdateOrder()
 
-Delete Orders (Beta)
+Delete Orders (Beta)
+
+### 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.deleteUpdateOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order 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)
+
+# **deleteUpdateShipment**
+> deleteUpdateShipment()
+
+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.deleteUpdateShipment(
+    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)
+
+# **getGetAdminEditableOrder**
+> AdminOrderRequestDTO getGetAdminEditableOrder()
+
+Get Editable Order (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.getGetAdminEditableOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**AdminOrderRequestDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Request |  -  |
+|**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)
+
+# **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)
+
+# **getGetCommercialInvoice**
+> File getGetCommercialInvoice()
+
+Get Commercial Invoice 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)
+let batchId: number; //Batch ID (default to undefined)
+let shipmentId: number; //Shipment ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetCommercialInvoice(
+    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
+
+**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)
+
+# **getGetEditableOrder**
+> DetailedOrderRequestDTO getGetEditableOrder()
+
+Get Editable Order (Beta)
+
+### 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.getGetEditableOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**DetailedOrderRequestDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Request |  -  |
+|**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)
+
+# **getGetItemSerialInfo**
+> ProductSerialInfoModel getGetItemSerialInfo()
+
+Get Item Serial Info (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 itemId: number; //Shipment Item ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetItemSerialInfo(
+    id,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
+
+
+### Return type
+
+**ProductSerialInfoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Serial Info |  -  |
+|**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)
+
+# **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)
+
+# **getGetOrderSummary**
+> OrderSummaryDTO getGetOrderSummary()
+
+Get Order Summary (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.getGetOrderSummary(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**OrderSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Summary |  -  |
+|**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()
+
+Get Orders (Beta)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+let fulfillable: boolean; //Fulfillable (optional) (default to undefined)
+let status: 'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'; //Status (optional) (default to undefined)
+let filter: 'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'; //Filter (optional) (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetOrders(
+    pageSize,
+    page,
+    search,
+    fulfillable,
+    status,
+    filter,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+| **fulfillable** | [**boolean**] | Fulfillable | (optional) defaults to undefined|
+| **status** | [**&#39;PAID&#39; | &#39;INVOICE_PAID&#39; | &#39;UNPAID&#39; | &#39;QUOTE&#39;**]**Array<&#39;PAID&#39; &#124; &#39;INVOICE_PAID&#39; &#124; &#39;UNPAID&#39; &#124; &#39;QUOTE&#39;>** | Status | (optional) defaults to undefined|
+| **filter** | [**&#39;OUTSTANDING&#39; | &#39;QUOTES&#39; | &#39;ALL&#39; | &#39;BACK_ORDERS&#39;**]**Array<&#39;OUTSTANDING&#39; &#124; &#39;QUOTES&#39; &#124; &#39;ALL&#39; &#124; &#39;BACK_ORDERS&#39;>** | Filter | (optional) defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**OrderSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **patchCompleteOrder**
+> OrderDetailsDTO patchCompleteOrder()
+
+Mark Order As Complete (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.patchCompleteOrder(
+    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)
+
+# **postAddOrderNote**
+> AuditLogEntity postAddOrderNote()
+
+Add Order Note
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    PostAddOrderNoteRequest
+} 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)
+
+const { status, data } = await apiInstance.postAddOrderNote(
+    id,
+    postAddOrderNoteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postAddOrderNoteRequest** | **PostAddOrderNoteRequest**|  | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**AuditLogEntity**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Audit Log Entry |  -  |
+|**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()
+
+Create An Order (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    AdminOrderRequestDTO
+} 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)
+
+const { status, data } = await apiInstance.postCreateAdminOrder(
+    readonly,
+    adminOrderRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin 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)
+
+# **postCreateConsignment**
+> ShipmentDTO 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
+
+**ShipmentDTO**
+
+### 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
 
@@ -30,9 +1089,13 @@ 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.deleteUpdateOrder(
-    id
+const { status, data } = await apiInstance.postPrintShippingLabel(
+    id,
+    shipmentId,
+    printer
 );
 ```
 
@@ -41,11 +1104,13 @@ const { status, data } = await apiInstance.deleteUpdateOrder(
 |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
 
-void (empty response body)
+**File**
 
 ### Authorization
 
@@ -54,23 +1119,24 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Accept**: text/html
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | No Response |  -  |
+|**200** | Shipping Label |  -  |
+|**204** | 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)
 
-# **getGetAdminEditableOrder**
-> AdminOrderRequestDTO getGetAdminEditableOrder()
+# **postSendOrderEmail**
+> postSendOrderEmail()
 
-Get Editable Order (Admin)
+Send Order Email
 
 ### Example
 
@@ -84,9 +1150,11 @@ 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.getGetAdminEditableOrder(
-    id
+const { status, data } = await apiInstance.postSendOrderEmail(
+    id,
+    email
 );
 ```
 
@@ -95,11 +1163,12 @@ const { status, data } = await apiInstance.getGetAdminEditableOrder(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
+| **email** | [**string**] | Email Address | defaults to undefined|
 
 
 ### Return type
 
-**AdminOrderRequestDTO**
+void (empty response body)
 
 ### Authorization
 
@@ -108,23 +1177,23 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Order Request |  -  |
+|**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)
 
-# **getGetEditableOrder**
-> DetailedOrderRequestDTO getGetEditableOrder()
+# **postSendShipmentEmail**
+> postSendShipmentEmail()
 
-Get Editable Order (Beta)
+Send Shipment Email (Admin)
 
 ### Example
 
@@ -138,9 +1207,15 @@ 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 email: string; //Email Address (default to undefined)
 
-const { status, data } = await apiInstance.getGetEditableOrder(
-    id
+const { status, data } = await apiInstance.postSendShipmentEmail(
+    id,
+    batchId,
+    shipmentId,
+    email
 );
 ```
 
@@ -149,11 +1224,14 @@ const { status, data } = await apiInstance.getGetEditableOrder(
 |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|
+| **email** | [**string**] | Email Address | defaults to undefined|
 
 
 ### Return type
 
-**DetailedOrderRequestDTO**
+void (empty response body)
 
 ### Authorization
 
@@ -162,23 +1240,23 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Order Request |  -  |
+|**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)
 
-# **getGetOrders**
-> OrderSummariesModel getGetOrders()
+# **postSendSupplierEmail**
+> postSendSupplierEmail()
 
-Get Orders (Beta)
+Send Supplier Email
 
 ### Example
 
@@ -191,22 +1269,12 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let pageSize: number; //Number Of Results (optional) (default to 20)
-let page: number; //Page Number (optional) (default to 1)
-let search: string; //Search (optional) (default to undefined)
-let fulfillable: boolean; //Fulfillable (optional) (default to undefined)
-let status: 'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'; //Status (optional) (default to undefined)
-let filter: 'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'; //Filter (optional) (default to undefined)
-let customerId: number; //Customer ID (optional) (default to undefined)
+let id: number; //Order ID (default to undefined)
+let batchId: number; //Batch ID (default to undefined)
 
-const { status, data } = await apiInstance.getGetOrders(
-    pageSize,
-    page,
-    search,
-    fulfillable,
-    status,
-    filter,
-    customerId
+const { status, data } = await apiInstance.postSendSupplierEmail(
+    id,
+    batchId
 );
 ```
 
@@ -214,18 +1282,13 @@ const { status, data } = await apiInstance.getGetOrders(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
-| **page** | [**number**] | Page Number | (optional) defaults to 1|
-| **search** | [**string**] | Search | (optional) defaults to undefined|
-| **fulfillable** | [**boolean**] | Fulfillable | (optional) defaults to undefined|
-| **status** | [**&#39;PAID&#39; | &#39;INVOICE_PAID&#39; | &#39;UNPAID&#39; | &#39;QUOTE&#39;**]**Array<&#39;PAID&#39; &#124; &#39;INVOICE_PAID&#39; &#124; &#39;UNPAID&#39; &#124; &#39;QUOTE&#39;>** | Status | (optional) defaults to undefined|
-| **filter** | [**&#39;OUTSTANDING&#39; | &#39;QUOTES&#39; | &#39;ALL&#39; | &#39;BACK_ORDERS&#39;**]**Array<&#39;OUTSTANDING&#39; &#124; &#39;QUOTES&#39; &#124; &#39;ALL&#39; &#124; &#39;BACK_ORDERS&#39;>** | Filter | (optional) defaults to undefined|
-| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
 
 
 ### Return type
 
-**OrderSummariesModel**
+void (empty response body)
 
 ### Authorization
 
@@ -234,23 +1297,23 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Order Summaries |  -  |
+|**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)
 
-# **postCreateAdminOrder**
-> Array<OrderSummaryDTO> postCreateAdminOrder()
+# **postSplitOrder**
+> Array<OrderSummaryDTO> postSplitOrder()
 
-Create An Order (Admin)
+Split Order
 
 ### Example
 
@@ -258,18 +1321,18 @@ Create An Order (Admin)
 import {
     OrdersApi,
     Configuration,
-    AdminOrderRequestDTO
+    PostSplitOrderRequest
 } 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 id: number; //Order ID (default to undefined)
+let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
 
-const { status, data } = await apiInstance.postCreateAdminOrder(
-    readonly,
-    adminOrderRequestDTO
+const { status, data } = await apiInstance.postSplitOrder(
+    id,
+    postSplitOrderRequest
 );
 ```
 
@@ -277,8 +1340,8 @@ const { status, data } = await apiInstance.postCreateAdminOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+| **postSplitOrderRequest** | **PostSplitOrderRequest**|  | |
+| **id** | [**number**] | Order ID | defaults to undefined|
 
 
 ### Return type
@@ -305,10 +1368,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)
 
-# **postGetOrders**
-> Array<OrderSummaryDTO> postGetOrders()
+# **putAllocateItems**
+> Array<BatchDTO> putAllocateItems()
 
-Create An Order (Beta)
+Allocate Items To Supplier
 
 ### Example
 
@@ -316,18 +1379,20 @@ Create An Order (Beta)
 import {
     OrdersApi,
     Configuration,
-    CustomerOrderRequestDTO
+    PutAllocateItemsRequest
 } 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)
+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.postGetOrders(
-    readonly,
-    customerOrderRequestDTO
+const { status, data } = await apiInstance.putAllocateItems(
+    id,
+    supplierId,
+    putAllocateItemsRequest
 );
 ```
 
@@ -335,13 +1400,14 @@ const { status, data } = await apiInstance.postGetOrders(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+| **putAllocateItemsRequest** | **PutAllocateItemsRequest**|  | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **supplierId** | [**number**] | Supplier ID | defaults to undefined|
 
 
 ### Return type
 
-**Array<OrderSummaryDTO>**
+**Array<BatchDTO>**
 
 ### Authorization
 
@@ -356,7 +1422,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Order Summaries |  -  |
+|**200** | Order Batches |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
@@ -424,6 +1490,70 @@ 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)
 
+# **putUpdateBatchItem**
+> OrderedItemModel putUpdateBatchItem()
+
+Update Batch Item (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrderedItemModel
+} 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 itemId: number; //Ordered Item ID (default to undefined)
+let orderedItemModel: OrderedItemModel; //Batch Item (optional)
+
+const { status, data } = await apiInstance.putUpdateBatchItem(
+    id,
+    batchId,
+    itemId,
+    orderedItemModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
+
+
+### Return type
+
+**OrderedItemModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ordered Item |  -  |
+|**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)
+
 # **putUpdateOrder**
 > Array<OrderSummaryDTO> putUpdateOrder()
 
@@ -485,3 +1615,124 @@ 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)
 
+# **putUpdatePaymentStatus**
+> OrderDetailsDTO putUpdatePaymentStatus()
+
+Change Payment Status (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 paid: boolean; //Paid (default to undefined)
+
+const { status, data } = await apiInstance.putUpdatePaymentStatus(
+    id,
+    paid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **paid** | [**boolean**] | Paid | 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)
+
+# **putUpdateShipment**
+> ShipmentDTO putUpdateShipment()
+
+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.putUpdateShipment(
+    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
+
+**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)
+