List shipments

GET 
/shipments

Returns a paginated list of shipments. Filter by status, direction, sales order number, or date range. Shipment statuses progress from pending through dispatched and in_transit to delivered, with cancelled as a terminal state.

Request

Response

200

Paginated shipments

400

Bad request — invalid parameters

401

Unauthorized — missing or invalid API key

Response

{
  "data": [
    {
      "shipmentNumber": "SHP-2025-0042",
      "salesOrderNumber": "SO-2025-0189",
      "customerName": "Sunrise Craft Beverages",
      "status": "dispatched",
      "direction": "outbound",
      "carrier": "FedEx",
      "trackingNumber": "794644790132",
      "trackingUrl": "https://www.fedex.com/track?trknbr=794644790132",
      "estimatedDispatchDate": "2025-03-10",
      "shippedDate": "2025-03-10",
      "estimatedDeliveryDate": "2025-03-15",
      "deliveredDate": "2025-03-14"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 87
  }
}