v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
shipments

Shipments - Get By Range

Retrieve shipments within a date range with optional warehouse filtering.

get/shipments/get_by_range

Query parameters

startstring

Start date for shipment range (ISO 8601)

Example:2025-01-01T00:00:00.000Z
endstring

End date for shipment range (ISO 8601)

Example:2025-01-31T23:59:59.000Z
pagenumber

Page number for pagination

Example:1
simpleboolean

Return simplified response with fewer fields

Response

Orders with shipments in the specified date range

Example response

{
  "orders": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "store_id": "507f1f77bcf86cd799439011",
      "tags": [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012"
      ],
      "shipments": [
        {
          "_id": "507f1f77bcf86cd799439011",
          "user_id": "507f1f77bcf86cd799439011",
          "time": "2025-01-15T12:00:00.000Z"
        }
      ]
    }
  ]
}