Shipping | Process Order
The ProcessOrders is used to process orders into deliveries.
Overview
| URL | api/{tenantKey}/{orgKey}/shipping/processOrders |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Process Order
Returns the list of entity records that can be processed by the 'Deliveries' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| company | (string) Company. |
The following elements are optional:
| warehouse | (string) Warehouse This is a query string parameter. |
| deliveryDateFrom | (DateTime?) Delivery Date From This is a query string parameter. |
| deliveryDateUntil | (DateTime?) Delivery Date Until This is a query string parameter. |
| loadingPoint | (string) Loading Point This is a query string parameter. |
| unloadingPoint | (string) Unloading Point This is a query string parameter. |
| party | (string) Party This is a query string parameter. |
| deliveryType | (string) Delivery Type This is a query string parameter. |
| sourceDocId | (Guid?) Source Doc Id This is a query string parameter. |
| sourceSchemaEntityId | (Guid?) Source Schema Entity Id This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ShippingOrderLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/processOrders/{pageIndex}/{pageSize}?warehouse={warehouse}&deliveryDateFrom={deliveryDateFrom}&deliveryDateUntil={deliveryDateUntil}&loadingPoint={loadingPoint}&unloadingPoint={unloadingPoint}&party={party}&deliveryType={deliveryType}&sourceDocId={sourceDocId}&sourceSchemaEntityId={sourceSchemaEntityId}
GET /shipping/processOrders/{pageIndex}/{pageSize}?warehouse={warehouse}&deliveryDateFrom={deliveryDateFrom}&deliveryDateUntil={deliveryDateUntil}&loadingPoint={loadingPoint}&unloadingPoint={unloadingPoint}&party={party}&deliveryType={deliveryType}&sourceDocId={sourceDocId}&sourceSchemaEntityId={sourceSchemaEntityId}
POST Post Shipping Order
Custom operation 'PostShippingOrder'.
The following elements are required:
| shippingOrder | (ShippingOrder) ShippingOrder. |
Response:
| When successful, the response body contains a unique identifier. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/processOrders/postShippingOrder
POST /shipping/processOrders/postShippingOrder
POST Process Order
Instructs the 'Deliveries' service to process the specified entity records.
The following elements are required:
| list | (ShippingOrderLine) List of the entity records that should be processed. See ShippingOrderLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/processOrders/{companyKey}
POST /shipping/processOrders/{companyKey}
Resources
ShippingOrder
The following elements are required:
| selectedCount | (int) Selected Count. |
| company | (string) Company. |
The following elements are optional:
| warehouse | (string) Warehouse. |
| deliveryDateFrom | (DateTime) Delivery Date From. |
| deliveryDateUntil | (DateTime) Delivery Date Until. |
| loadingPoint | (string) Loading Point. |
| unloadingPoint | (string) Unloading Point. |
| party | (string) Party. |
| deliveryType | (string) Delivery Type. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |
ShippingOrderLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| description | (string) Description. |
| originalQuantity | (decimal) Original Quantity. |
| openQuantity | (decimal) Open Quantity. |
| quantity | (decimal) Quantity. |
| unit | (string) Unit. |
| sourceDocKey | (string) Source Doc Key. |
| sourceDocLineNumber | (int) Source Doc Line Number. |
| deliveryDate | (DateTime) Delivery Date. |
| shippingRequestId | (Guid) Shipping Request Id. |
| shippingRequestLineId | (Guid) Shipping Request Line Id. |
| party | (string) Party. |
| item | (string) Item. |
| sourceDocId | (Guid) Source Doc Id. |
| sourceSchemaEntityId | (Guid) Source Schema Entity Id. |