shipments

Shipments - Get By Range

Changed on

Retrieve shipments within a date range with optional warehouse filtering.

get/shipments/get_by_range

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/shipments/get_by_range
  • Auth
    HTTP bearer

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"
        }
      ]
    }
  ]
}

Changes

  • fa53dd949b8eRevision changes
    • breaking

      for the query request parameter simple, the type changed from string to boolean

    • info

      api operation id get_shipments_get_by_range was added

    • info

      for the query request parameter end, the format was generalized from date to no format

    • info

      for the query request parameter page, the format was generalized from integer to no format

    • info

      for the query request parameter start, the format was generalized from date to no format

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 08cd9cfa14ddRevision changes
    • breaking

      for the query request parameter end, the format changed from no format to date

    • breaking

      for the query request parameter page, the type changed from string to number, and format from no format to integer

    • breaking

      for the query request parameter start, the format changed from no format to date

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status