Shipments
List shipments
Returns a paginated list of shipments, with optional filtering by payment, company, or user.
Required permissions:
- shipment:basic:read
- payment:basic:read
get/shipments
Query parameters
afterstring nullable
Returns the elements in the list that come after the specified cursor.
beforestring nullable
Returns the elements in the list that come before the specified cursor.
firstinteger nullable
Returns the first n elements from the list.
Example:42
lastinteger nullable
Returns the last n elements from the list.
Example:42
payment_idstring nullable
Filter shipments to only those associated with this specific payment.
Example:pay_xxxxxxxxxxxxxx
company_idstring nullable
Filter shipments to only those belonging to this company.
Example:biz_xxxxxxxxxxxxxx
user_idstring nullable
Filter shipments to only those for this specific user.
Example:user_xxxxxxxxxxxxx
Response
A successful response
Example response
{
"data": [
{
"created_at": "2023-12-01T05:00:00.401Z",
"delivery_estimate": "2023-12-01T05:00:00.401Z",
"id": "ship_xxxxxxxxxxxxx",
"payment": {
"id": "pay_xxxxxxxxxxxxxx"
},
"service": "Priority",
"tracking_code": "9400111899223456789012",
"updated_at": "2023-12-01T05:00:00.401Z"
}
]
}