Skip to main content

Transfer Dispatch Command

Actors

  • Akinon Order Management System (OMS)
  • Integrated Application (ERP)

Domain Objects

  • Packaging Order
  • Transfer Order
  • OMS Command (Transfer Order Command)
  • Transfer Scenario

Process

  1. 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.
  2. 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.
  3. 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.
  4. Once the product has arrived at the transfer location (source) and is ready to be dispatched via the shipping company or courier, the relevant employee runs the Transfer Dispatch Command using the Instore application or OMS command services via the integrated software.
  5. With the Transfer Dispatch process, shipment tracking is commenced for the relevant Transfer Orders. No shipment tracking in shipments is offered by the courier/brand’s in-house logistics.
  6. When this command is run, the Transfer Order changes from the Waiting or Ready for Shipment status to the In Transit status.
  7. Running the command in other states will trigger a validation error.

Command Parameters and Prerequisites

For each Transfer Order:

ParameterParameter NameParameter TypeParameter DescriptionRequirement
Transfer Order IDtransferintegerDynamic for each orderMandatory
Command Transition IDtransitionintegerPrepared and reported during OMS installationOptional if slug is given
SlugslugslugUnique slug for stste transitionOptional if Command Transition ID is given

POST Transfer 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