Skip to main content

Ship The Package Command

Actors

  • Akinon Order Management System (OMS)
  • Omnitron

Domain Objects

  • Advanced Shipment Order
  • OMS Command (Shipment Order Command)

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. The products in the order are distributed to the Packaging Orders by running the rules in the distribution scenarios designated by the brand.
  3. Packaging Orders are transferred to the Akinon Instore App or the brand’s integrated software. (Packaging Orders Webhooks)
  4. Packaging orders assigned to the Store/Warehouse commence in the Waiting status.
  5. When the packaging is made physically ready for distribution in one or more steps, the transition to the Packed status is made by using the screens in the Akinon Instore application or when a piece of software integrated into the OMS application runs the OMS commands (see: OMS Commands API).
  6. This command is run to used to move packages from the Packed to Shipped status. This command does not notify the shipping company; it only records the provided information in the system and synchronizes the order data with Omnitron. If the Notify Invoice Information (remote_invoice_call) setting was entered, an invoice notification request is sent to the address specified with this setting.

Command Parameters and Prerequisites

For each packaging order:

  • Packaging Order ID (integer – dynamic for each order)
  • Command Transition ID (integer prepared and reported during OMS installation)
  • slug (string - unique for each state transition - Either slug or Command Transition ID is required)

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


POST Ship The Package

Path: https://{customer_api_url}-oms.akinon.net/api/v1/oms/packages/{package_id}/command/

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

Request Body

    {
"transition": NNN,
"slug": SSS,
"package": XXX
}

Successful Response

Status Code: 204 No Content