Shipment Dispatch Notification

When a shipment is dispatched from the warehouse, the WMS sends a dispatch notification to the host system with details of what was shipped.

A dispatch notification with quantity: 0 for all lines indicates a cancelled dispatch — the shipment will not be fulfilled.

Direction WMS → Host

HTTP Method POST

Path {host-url}/dispatch-notification

Request Body

{
  "warehouseName": "WAREHOUSE_01",
  "shipmentNumber": "SHP-2024-001234",
  "dispatchDate": "2024-01-25T14:30:00.000Z",
  "dispatchNotificationLines": [
    {
      "productId": "PROD-ABC123",
      "quantity": 2,
      "stockOwner": "OWNER_A",
      "batchInformations": [
        {
          "batchNumber": "BATCH-001",
          "status": "GOOD",
          "quantity": 2,
          "expirationDate": "2025-06-30"
        }
      ],
      "unitIdentifierCollections": []
    }
  ],
  "dispatchNotificationMetadata": [
    {
      "key": "carrierService",
      "value": "NEXT_DAY"
    }
  ]
}

Responses

200: Dispatch notification accepted by host