v1
latestOpenAPI 3.1.02026-07-26162740.3 KBShipments
List all shipments
Retrieves a paginated list of shipments with optional filters.
get/client/shipments
Query parameters
pageinteger
Page number.
pageSizeinteger
Results per page.
status'DRAFT' | 'PENDING' | 'PENDING_REVIEW' | 'PICKUP_REQUESTED' | 'PICKUP_CANCELLED' | 'PARTNER_RECEIVED' | 'PICKED_UP' | 'RECEIVED' | 'GATEWAY_TRANSIT' | 'PARCEL_SCANNED' | 'TRANSSHIPMENT_COMPLETE' | 'IN_TRANSIT' | 'OUT_FOR_DELIVERY' | 'DELIVERED' | 'SHIPMENT_EXCEPTION' | 'AGED_OUT' | 'RETURNED' | 'CANCELLED' | 'STORAGE' | 'FAILED' | 'FAILED_DELIVERY1' | 'FAILED_DELIVERY2' | 'GATEWAY_TO_GATEWAY_TRANSIT' | 'GATEWAY_TRANSIT_OUT'
Shipment status.
Filter by shipment status.
fromDatestring date
Filter shipments created on or after this date (YYYY-MM-DD).
toDatestring date
Filter shipments created on or before this date (YYYY-MM-DD).
querystring
Search keyword. Matches against order number, tracking ID, recipient name, phone, or email.
Response
Paginated list of shipments