Skip to main content

Ship The Package without Shipment Integration Command

Actors​

  • Akinon Order Management System (OMS)

Domain Objects​

  • Packaging Order
  • Omnitron Token
  • User ID
  • Command

Process​

  1. After the order is packed, the OMS application notifies the shipping company. This command is used to update the relevant package to the Shipped status without shipment integration.
  2. In state transitions, the package item status on Omnitron must be identical for completion. Otherwise, a transition error is triggered.
  3. If no error is thrown after the command is run, the relevant packages and items will be moved to the Shipped status.

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 after a packaging order changes to the Packed Status, it will get a validation error, the prerequisite is considered complete for all packages that have passed to the Packed status (e.g. All items packed status).

POST Ship The Package without Shipment Integration​

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