v8
OpenAPI 3.1.02026-08-033623795.0 MBShipments
List Shipments
Returns a paginated list of shipments for an account.
get/shipments
Query parameters
account_idstring
The account to list shipments for. Defaults to the acting account.
status'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'available_for_pickup' | 'return_to_sender' | 'failure' | 'cancelled' | 'error'
Filter to shipments with this delivery status.
payment_idstring[]
Only shipments fulfilling these payments, each prefixed pay_. Repeat the parameter to pass several, up to 100 per request — one paginated list covers all of them.
created_beforestring
Return shipments created before this ISO 8601 timestamp.
created_afterstring
Return shipments created after this ISO 8601 timestamp.
order'created_at'
The field to sort by.
direction'asc' | 'desc'
The sort direction.
firstinteger
The number of shipments to return.
afterstring
A cursor; returns shipments after this position.
lastinteger
The number of shipments to return from the end of the range.
beforestring
A cursor; returns shipments before this position.
Response
excludes the created_after boundary row
Example response
{
"data": [
{
"status": "unknown"
}
]
}