Shipping | Process Order
Service to allow picking of orders to process for shipping purpose.
Overview
| URL | api/{tenantKey}/{orgKey}/shipping/processOrders |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
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) The company's code is the central organizational unit within the system. |
The following elements are optional:
| warehouse | (string) The warehouse from where the goods will be shipped. This is a query string parameter. |
| deliveryDateFrom | (DateTime?) The shipping request starting date. Ignored if not set, is used to filter the date in which you expect to deliver the goods. Only shipping requests with delivery date greater than or equal to this value will be displayed. This is a query string parameter. |
| deliveryDateUntil | (DateTime?) The shipping request end date. Ignored is not set is used to filter the date in which you expect to deliver the goods. Only shipping requests with delivery date less than or equal to this value will be displayed. This is a query string parameter. |
| loadingPoint | (string) The physical location where the goods are loaded. The default is the company physical location. This is a query string parameter. |
| unloadingPoint | (string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is the customer address. This is a query string parameter. |
| party | (string) The customer to whom the shipping will be delivered. This is a query string parameter. |
| deliveryType | (string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. The default delivery type is defined in the sales setup configuration setting. 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}
GET /shipping/processOrders/{pageIndex}/{pageSize}?warehouse={warehouse}&deliveryDateFrom={deliveryDateFrom}&deliveryDateUntil={deliveryDateUntil}&loadingPoint={loadingPoint}&unloadingPoint={unloadingPoint}&party={party}&deliveryType={deliveryType}
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) The number of selected lines. Internally calculated. |
| company | (string) The company's code is the central organizational unit within the system. |
The following elements are optional:
| warehouse | (string) The warehouse from where the goods will be shipped. |
| deliveryDateFrom | (DateTime) The shipping request starting date. Ignored if not set, is used to filter the date in which you expect to deliver the goods. Only shipping requests with delivery date greater than or equal to this value will be displayed. |
| deliveryDateUntil | (DateTime) The shipping request end date. Ignored is not set is used to filter the date in which you expect to deliver the goods. Only shipping requests with delivery date less than or equal to this value will be displayed. |
| loadingPoint | (string) The physical location where the goods are loaded. The default is the company physical location. |
| unloadingPoint | (string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is the customer address. |
| party | (string) The customer to whom the shipping will be delivered. |
| deliveryType | (string) Defines the delivery's purpose. Distinguishes the business transactions to be posted. The default delivery type is defined in the sales setup configuration setting. |
ShippingOrderLine
The following elements are required:
| selected | (bool) Indicates if the line has been selected to be included on the delivery. |
| hasDiscountInValue | (bool) Has Discount In Value. |
The following elements are optional:
| description | (string) The description of the item on the source document line. Infered from the source document line. |
| originalQuantity | (decimal) The shipping request line item quantity. Infered from the source document line. |
| openQuantity | (decimal) It indicates the current open quantity of the original document line. One original document document line can be partially settled over multiple deliveries. Internally determined. Infered from source document line. |
| quantity | (decimal) The quantity to be included on the delivery to be created. |
| unit | (string) The item's unit. Infered from the source document line. |
| sourceDocKey | (string) The source's document. Internally determined. |
| sourceDocLineNumber | (int) The source document's line number. Internally determined. |
| deliveryDate | (DateTime) The expected delivery date. Infered from the source document line. |
| shippingRequestId | (Guid) The unique identifier of the shipping request. Internally determined. |
| shippingRequestLineId | (Guid) The unique identifier of the shipping request line. Internally determined. |
| party | (string) The customer of the original shipping request. Infered from the source document. |
| item | (string) The item of the shipping request. Infered from the source document line. |