Skip to main content
GET
/
v1
/
shipments
List
curl --request GET \
  --url https://{defaultHost}/v1/shipments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/shipments"
  },
  "data": [
    {
      "id": "c583b9d5-0a0f-427d-b7d4-73d0e0d38dc0",
      "object": "shipment",
      "status": "draft",
      "live_mode": true,
      "label_url": null,
      "label_file_type": "PDF",
      "tracking_number": null,
      "tracking_url": null,
      "tracking_status": null,
      "eta": null,
      "weight": "2.0",
      "weight_unit": "lb",
      "shipping_date": 1775174400,
      "carrier": null,
      "dimensions": {
        "length": 10,
        "width": 8,
        "height": 5,
        "unit": "in"
      },
      "rates": [],
      "selected_rate": null,
      "fulfillment": "db86a6fd-902f-43e5-815e-bc85410251ae",
      "shipping_provider": "e4cf91cb-8e77-4a37-b36e-e5b7d4205e2d",
      "from_contact": "a878ecdf-841a-4eed-989b-7c8d354646c5",
      "to_contact": "13eac184-d6ab-4603-8741-62c06dbc2cbf",
      "parcel_template": null,
      "created_at": 1775219009,
      "updated_at": 1775219009
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fulfillment_ids[]
string[]

Only return objects that belong to the given fulfillments.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.