Transfer Ready for Dispatch 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.
- When the product is confirmed to be at the transfer location (source) and is ready to be dispatched, the relevant store/warehouse employee runs the Transfer Ready for Dispatch command via the Instore screen or the OMS command API.
- When this command is run, the Transfer Order changes to the Ready for Shipment status, preventing any product not found/wrong product commands from triggering.
- The Transfer Ready for Dispatch Command may only be used for the Transfer Orders in Waiting 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 Ready for Dispatch
Path: https://{customer_api_url}-oms.akinon.net/api/v1/oms/transfer_orders/<transferOrder_id>/command/
Request Body
{
"transition": XXX, // command transition ID value
"slug": SSS,
"transfer_order": TRANSFER_ORDER
}
Successful Response
Status Code: 204 No Content