---
title: "Shipments - Get By Range"
method: GET
path: "/shipments/get_by_range"
tags: ["shipments"]
---

# Shipments - Get By Range

`GET /shipments/get_by_range`

Retrieve shipments within a date range with optional warehouse filtering.

## Query parameters

- `start` string — Start date for shipment range (ISO 8601)
- `end` string — End date for shipment range (ISO 8601)
- `page` number — Page number for pagination
- `simple` boolean — Return simplified response with fewer fields

## Response `200`

Orders with shipments in the specified date range

- object
  - `orders` object[], required — Orders with shipments in the date range
    - `_id` string, required — Order ID
    - `store_id` string, required — Store ID
    - `order_number` string, required — Order number
    - `batch_number` string — Batch number
    - `status` string — Order status
    - `tags` string[] — Array of order tag IDs (ObjectId strings referencing the tag collection)
    - `notes` object[] — Order notes
    - `shipments` Shipment[] — Shipments on this order
      - `_id` string — Shipment ID
      - `user_id` string — User who created the shipment
      - `time` string — Shipment creation time
      - `voided` boolean — Whether the shipment is voided
      - `return_label` boolean — Whether this is a return label
      - `deducted` boolean — Whether inventory was deducted
      - `response` object — Shipment response details
        - `provider` string — Carrier provider name
        - `service` string — Service name
        - `label_url` string — Label URL
        - `tracking_number` string — Tracking number
        - `tracking_url` string — Tracking URL
        - `amount` number — Shipping cost amount
        - `currency` string — Currency code
        - `shipment_id` string — External shipment ID
        - `signature` boolean — Signature confirmation
      - `request` object — Shipment request parameters
        - `order_items` ShipmentOrderItem[] — Items included in shipment
          - `item_id` string — Item ID
          - `variant_id` string — Variant ID
          - `quantity` number — Quantity shipped
          - `sku` string — Item SKU
        - `parcel` object — Parcel dimensions
          - `length` number — Package length
          - `width` number — Package width
          - `height` number — Package height
          - `weight` number — Package weight
          - `weight_unit` string — Weight unit
          - `dimensions_unit` string — Dimensions unit
        - `address` object — Ship-to address used in request
        - `carrier_account_ids` string[] — Carrier account IDs
        - `provider` string — Carrier provider
        - `service` unknown
    - `stash` object — Order stash data (included when simple is false)
  - `skulabs_warning` object — Warning if results were truncated
    - `message` string, required — Warning message
    - `type` string, required — Warning type

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden. Insufficient permissions.
- `429` — Too many requests. Rate limit exceeded.
- `500` — Internal server error.

---

[API](https://skmtc.net/skulabs/apis/skulabs-api.md) · [All operations](https://skmtc.net/skulabs/apis/skulabs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/skulabs/skulabs-api/revisions/4b5ec0ed78a6/schema)