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": "d68a662e-cc31-4fa7-bbb3-cca4f4afd540",
      "object": "shipment",
      "carrier": null,
      "carrier_messages": [],
      "contact_validations": null,
      "dimensions": {
        "length": 10,
        "width": 8,
        "height": 5,
        "unit": "in"
      },
      "eta": null,
      "inherit_weight": false,
      "label_file_type": "PDF",
      "label_url": null,
      "live_mode": true,
      "rates": [],
      "selected_rate": null,
      "shipping_date": 1776124800,
      "status": "draft",
      "tracking_number": null,
      "tracking_status": null,
      "tracking_url": null,
      "weight": "2.0",
      "weight_unit": "lb",
      "from_contact": "f2e6cff4-1010-4bb8-8c8f-2e442fb30096",
      "fulfillment": "88b818e1-ef5d-4daa-be54-4888c05ef24d",
      "parcel_template": null,
      "shipping_provider": "bc08549b-001c-4982-b5ad-8b440e1c2710",
      "to_contact": "b9a944e6-3c24-4a9f-b55c-228dcaefd1a7",
      "created_at": 1776176578,
      "updated_at": 1776176578
    }
  ]
}

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.