Transfer Delivered Command
Actors
- Akinon Order Management System (OMS)
- Integrated Application (ERP)
Domain Objects
- Packaging Order
- Transfer Order
- OMS Command (Transfer Order Command)
- Packaging Rule
- Transfer Scenario
Process
- The OMS application copies orders from the Akinon Omnitron Application to itself to prepare delivery/distribution plans, generate packaging orders and transfer them to operation points.
- If the products in the order have the Transferable feature enabled in any of the Packaging Rules in the distribution scenario, Transfer Orders are generated to send the missing products from different operation points to the package dispatch location by running the Transfer Scenario.
- Transfer order(s) are associated with Packaging Orders and with the order indirectly by marking the destination point as the customer’s shipping location, and the starting point as the stock location.
- The Transfer Order received by the employee of the packaging location using the Instore screens or OMS command services (when received by the destination) is moved to the Transfer Complete status.
- If all transfer orders of the package are in the Transfer Complete status, the OMS automatically changes the status of the relevant package from Waiting for Transfer to Waiting.
- If there are any incomplete Transfer Orders besides this one, the Packaging Order remains in the Waiting for Transfer status.
- This command can only be run when the relevant Transfer Order is in the In Transit status. Running the command in other states will trigger a validation error.
Command Parameters and Prerequisites
For each Transfer Order:
Parameter | Parameter Name | Parameter Type | Parameter Description | Requirement |
---|---|---|---|---|
Transfer Order ID | transfer | integer | Dynamic for each order | Mandatory |
Command Transition ID | transition | integer | Prepared and reported during OMS installation | Optional if slug is given |
Slug | slug | slug | Unique slug for stste transition | Optional if Command Transition ID is given |
POST
Transfer Delivered
Path: https://{customer_api_url}-oms.akinon.net/api/v1/oms/transfer_orders/<TransferOrderID>/command/
Request Body
{
"transition": XXX,
"slug": SSS,
"transfer_order": TRANSFER_ORDER
}
Successful Response
Status Code: 204 No Content