Skip to main content

Transfer Order Advanced 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​

  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. 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 Advanced Transfer Ready for Dispatch command via the Instore screen or the OMS command API. When this command is run, the shipping company and tracking number are entered externally. The command does not notify the shipping company; it only records the provided information in the system.

  5. 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.

  6. The Advanced 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:

  • Transfer Order ID (integer – dynamic for each order)

  • Command Transition ID (integer – constant – prepared and reported during OMS installation)

  • Slug (string - unique for each state transition - Either slug or Command Transition ID is required)

  • Shipment Tracking Number

  • Shipping Company

  • Shipment Query Number (used for shipment status queries by the OMS. Not mandatory.)

If this command is run before a transfer order is moved to the Waiting status, a validation error will be triggered.

POST Transfer Order Advanced​

Path: https://{customer_api_url}-oms.akinon.net/api/v1/oms/transfer_orders/<transferOrder_id>/command/

  • Transfer Order ID: XXX
  • Transition ID: NNN (set after OMS installation)
  • Slug: SSS (Unique Slug Value)

Request Body​

{
    "transition": NNN,
    "slug": SSS,
    "transfer_orders": XXX,
    "input_parameters": {
        "tracking_number": "12312ASD123123",
        "cargo_company": "MNG",
        "query_number": "1212121212"
    }
}

Successful Response​

Status Code: 204 No Content