Shipments - Get By Range

Retrieve shipments within a date range with optional warehouse filtering.

GET /shipments/get_by_range

Shipments - Get By Range

cURL

curl --request GET \
  --url https://api.skulabs.com/shipments/get_by_range \
  --header 'Authorization: Bearer <token>'

200

{
  "orders": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "store_id": "507f1f77bcf86cd799439011",
      "order_number": "<string>",
      "batch_number": "<string>",
      "status": "<string>",
      "tags": [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012"
      ],
      "notes": [
        {}
      ],
      "shipments": [
        {
          "_id": "507f1f77bcf86cd799439011",
          "user_id": "507f1f77bcf86cd799439011",
          "time": "2025-01-15T12:00:00.000Z",
          "voided": true,
          "return_label": true,
          "deducted": true,
          "response": {
            "provider": "<string>",
            "service": "<string>",
            "label_url": "<string>",
            "tracking_number": "<string>",
            "tracking_url": "<string>",
            "amount": 123,
            "currency": "<string>",
            "shipment_id": "<string>",
            "signature": true
          },
          "request": {
            "order_items": [
              {
                "item_id": "<string>",
                "variant_id": "<string>",
                "quantity": 123,
                "sku": "<string>"
              }
            ],
            "parcel": {
              "length": 123,
              "width": 123,
              "height": 123,
              "weight": 123,
              "weight_unit": "<string>",
              "dimensions_unit": "<string>"
            },
            "address": {},
            "carrier_account_ids": [
              "<string>"
            ],
            "provider": "<string>",
            "service": "<unknown>"
          }
        }
      ],
      "stash": {}
    }
  ],
  "skulabs_warning": {
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start · string

Start date for shipment range (ISO 8601)

Example:

"2025-01-01T00:00:00.000Z"

end · string

End date for shipment range (ISO 8601)

Example:

"2025-01-31T23:59:59.000Z"

page · number

Page number for pagination

Example:

1

simple · boolean

Return simplified response with fewer fields

Response

200

application/json

Orders with shipments in the specified date range

orders · object[] · required

Orders with shipments in the date range

Show child attributes

skulabs_warning · object

Warning if results were truncated

Show child attributes