> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# `GET /api/v1/shipments`

> `GET /api/v1/shipments`

### Query parameters

<ParamField query="limit" type="integer (int32)">
  Maximum number of results to return (default: 50).
</ParamField>

<ParamField query="offset" type="integer (int32)">
  Number of results to skip (default: 0).
</ParamField>

<ParamField query="order_id" type="string">
  Filter by order ID (UUID).
</ParamField>

<ParamField query="status" type="string">
  Filter by shipment status (pending, shipped, `in_transit`, delivered, returned, cancelled).
</ParamField>

<ParamField query="carrier" type="string">
  Filter by carrier (usps, ups, fedex, dhl, etc.).
</ParamField>

<ParamField query="tracking_number" type="string">
  Filter by tracking number.
</ParamField>

### Responses

<ResponseField name="200" type="ShipmentListResponse">
  List of shipments
</ResponseField>

<ResponseField name="400" type="ErrorBody">
  Invalid filter parameter
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.stateset.com/api/v1/shipments' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "has_more": true,
    "limit": 1,
    "offset": 1,
    "shipments": [
      {
        "carrier": "string",
        "created_at": "2026-07-24T12:00:00Z",
        "delivered_at": null,
        "estimated_delivery": null,
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "recipient_name": "string",
        "shipment_number": "string",
        "shipped_at": null,
        "shipping_cost": null,
        "shipping_method": "string",
        "status": "string",
        "tracking_number": null,
        "tracking_url": null,
        "updated_at": "2026-07-24T12:00:00Z"
      }
    ],
    "total": 1
  }
  ```
</ResponseExample>