List Shipments
Query Parameters
carrier_codestring
Carrier code
service_codestring
Service code
ship_from_timestring
Date format YYYY-MM-DD hh:mm:ss p or DD-MM-YYYY hh:mm:ss p
ship_to_timestring
Date format YYYY-MM-DD hh:mm:ss p or DD-MM-YYYY hh:mm:ss p
shipment_batch_idstring
Shipment Batch ID to search for.
Default value
null
pageinteger
Page offset to fetch. 1 is default.
per_pageinteger
Number of results to return per page. 100 is default.
statusstring
Filter shipments based on status. Defaults to all
Default value
all
Enum values:
allpendingshippedcanceledpartialcancel pendingcancel rejectedshipment_pendingin_progressfailed... 1 other enums
tracking_numberstring
An array of tracking_numbers for shipments you are looking for.
Body Parameters
tracking_numberarray
Tracking Number(s) to search for.
Response
200
Object
List Shipments
Response Attributes
shipmentsarray
Shipments
Show child attributes
Was this section helpful?
Response
Was this section helpful?