List Shipments

List all shipments with filtering and pagination

This endpoint retrieves a paginated list of shipments. Use filters to narrow results by status, date range, carrier, and more.

Authentication

This endpoint requires a valid API key with shipments:read permissions.

Authorization: Bearer YOUR_API_KEY

Query Parameters

limit · integer

Number of items to return (default: 20, max: 100)

offset · integer

Number of items to skip

status · string

Filter by status: “label_created”, “picked_up”, “in_transit”, “out_for_delivery”, “delivered”, “returned”, “failed”

carrier · string

Filter by carrier: “ups”, “fedex”, “usps”, “dhl”

warehouse_id · string

Filter by origin warehouse

order_id · string

Filter by associated order

tracking_number · string

Filter by tracking number

ship_date_from · string

Filter by ship date start (ISO 8601)

ship_date_to · string

Filter by ship date end (ISO 8601)

delivery_date_from · string

Filter by delivery date start (ISO 8601)

delivery_date_to · string

Filter by delivery date end (ISO 8601)

destination_country · string

Filter by destination country code

destination_state · string

Filter by destination state/province

sort_by · string

Sort field: “created_at”, “ship_date”, “delivery_date”, “status”

sort_order · string

Sort order: “asc” or “desc” (default: “desc”)

Response

object · string

Object type, always “list”

data · array

Array of shipment objects

has_more · boolean

Whether more items exist

total_count · integer

Total number of matching shipments

cURL

curl --location 'https://api.stateset.com/v1/shipments?status=in_transit&limit=10' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "object": "list",
  "data": [
    {
      "id": "ship_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "shipment",
      "status": "in_transit",
      "created_at": "2024-01-19T14:30:00Z",
      "ship_date": "2024-01-20T08:00:00Z",
      "delivery_date": "2024-01-23T18:00:00Z",
      "carrier": "ups",
      "service_type": "ground",
      "tracking_number": "1Z999AA10123456784",
      "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
      "packages_count": 1,
      "total_weight": {
        "value": 5.5,
        "unit": "lb"
      },
      "from_address": {
        "city": "Los Angeles",
        "state": "CA",
        "country": "US"
      },
      "to_address": {
        "name": "John Doe",
        "city": "Los Angeles",
        "state": "CA",
        "country": "US"
      },
      "order_ids": ["order_123456", "order_123457"],
      "rate": {
        "amount": 1250,
        "currency": "USD"
      }
    },
    {
      "id": "ship_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "shipment",
      "status": "in_transit",
      "created_at": "2024-01-19T10:15:00Z",
      "ship_date": "2024-01-19T14:00:00Z",
      "delivery_date": "2024-01-22T18:00:00Z",
      "carrier": "fedex",
      "service_type": "express",
      "tracking_number": "772123456789",
      "tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=772123456789",
      "packages_count": 2,
      "total_weight": {
        "value": 12.3,
        "unit": "lb"
      },
      "from_address": {
        "city": "New York",
        "state": "NY",
        "country": "US"
      },
      "to_address": {
        "name": "Jane Smith",
        "city": "Chicago",
        "state": "IL",
        "country": "US"
      },
      "order_ids": ["order_789012"],
      "rate": {
        "amount": 2850,
        "currency": "USD"
      }
    }
  ],
  "has_more": true,
  "total_count": 156,
  "page_info": {
    "limit": 10,
    "offset": 0
  }
}