GET
List shipments

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

order_id
string

Restrict the page to the shipments dispatched for one order. This is where the order-scoped list lives on this API; there is no /orders/{orderId}/shipments route, because "what has gone out since I last looked" cannot be asked through one without already knowing every order id.

status
enum<string>

Filter by the SHIPMENT's own state, which is not the order's fulfillment state: a store can record a shipment here and never touch a fulfillment, and the reverse. An unrecognised value is a 400 rather than an empty page, because "no shipment is in that state" and "there is no such state" are different facts and a client told the former concludes nothing has shipped and stops looking.

Available options:
created,
label_purchased,
in_transit,
delivered,
cancelled,
exception
limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object