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": "79f84656-c19c-4cd1-bdc5-4ac126ef24e8",
      "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": null,
      "weight_unit": "lb",
      "carrier": null,
      "dimensions": null,
      "rates": [],
      "selected_rate": null,
      "fulfillment": "be2ecfc9-4ed6-4189-a049-1a00241db405",
      "shipping_provider": "60a204b2-b460-44c3-8d89-972037c860cd",
      "from_address": null,
      "to_address": null,
      "parcel_template": null,
      "created_at": 1773748360,
      "updated_at": 1773748360
    }
  ]
}

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.