Shipment Status Report

The WMS sends shipment status reports to the host system, providing a snapshot of the current state of a shipment including its processing status and per-product stock states. The state field reflects the shipment’s current lifecycle stage and can be used by the host to track progression.

Notable states include:

• AWAITING_DISPATCH — shipment is packed and ready for collection/dispatch
• PACKED — shipment packing is complete
• DISPATCHED — shipment has left the warehouse
• CANCELLED — shipment has been cancelled

The stockStates map on each product shows the quantity breakdown by stock status (e.g. GOOD, DAMAGED, HELD).

Direction WMS → Host

HTTP Method POST

Path {host-url}/shipment-status

Request Body

{
  "shipmentNumber": "SHP-2024-001234",
  "state": "AWAITING_DISPATCH",
  "shipmentType": "CUSTOMER",
  "products": [
    {
      "productId": "PROD-ABC123",
      "externalProductReference": "EXT-REF-001",
      "stockStates": {
        "GOOD": 2
      }
    }
  ]
}

Responses

200: Status report accepted by host