Skip to main content
GET
List shipments
Returns 20 shipments per page, newest first. Results are always scoped to the workspace that owns the API key.
Filter by reference, customer name, customer email, or dropoff address.
string
Delivery status: pending, awaiting_pickup, in_transit, delivered, or cancelled.
string
Payment status: awaiting_payment, paid, failed, or refunded.
number
Page number. Defaults to 1.
object[]
required
Shipment objects. See Retrieve a shipment for the shape of each item.
object
required
Pagination: current_page, last_page, per_page (20), and total.