v1
latestOpenAPI 3.0.32026-07-26170311887.2 KBList all Shipments
Retrieve a list of shipments.
Required authorization scope: public.shipment:read
Query parameters
Page number to fetch, default: 1
Number of records per page to fetch, default: 20
Easyship Shipment ID provided when creating the shipment.
Order number on the sales platform.
Search for shipments created since this date: ISO8601 date format.
Search for shipments created before this date: ISO8601 date format.
Search for shipments updated since this date: ISO8601 date format.
Search for shipments updated before this date: ISO8601 date format.
Search for shipments where the labels were paid for since this date: ISO8601 date format.
Search for shipments where the labels were paid for before this date: ISO8601 date format.
Search for labels generated since this date: ISO8601 date format.
Search for labels generated before this date: ISO8601 date format.
Search by current status of shipment.
Search by current label status of shipment.
Search by current pickup status of shipment.
Search by current delivery status of shipment.
For eFulfilment only. Search by current warehouse status of shipment.
Search by the shipment origin country code: Alpha-2 format (ISO 3166-1).
Search by shipment destination country code: Alpha-2 format (ISO 3166-1).
Search by shipment whether the shipment is return shipment or not.
Response
list of shipments