List all Shipments

get

https://public-api.easyship.com/2024-09/shipments

Retrieve a list of shipments.

Required authorization scope: public.shipment:read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Page number to fetch, default: 1

per_page

integer

1 to 100

Number of records per page to fetch, default: 20

easyship_shipment_id

array of strings

Easyship Shipment ID provided when creating the shipment.

easyship_shipment_id

platform_order_number

string

Order number on the sales platform.

created_at_from

string

Search for shipments created since this date: ISO8601 date format.

created_at_to

string

Search for shipments created before this date: ISO8601 date format.

updated_at_from

string

Search for shipments updated since this date: ISO8601 date format.

updated_at_to

string

Search for shipments updated before this date: ISO8601 date format.

label_paid_at_from

string

Search for shipments where the labels were paid for since this date: ISO8601 date format.

label_paid_at_to

string

Search for shipments where the labels were paid for before this date: ISO8601 date format.

label_generated_at_from

string

Search for labels generated since this date: ISO8601 date format.

label_generated_at_to

string

Search for labels generated before this date: ISO8601 date format.

shipment_state

string

enum

Search by current status of shipment.

Allowed:

label_state

array of strings

Search by current label status of shipment.

label_state

pickup_state

array of strings

Search by current pickup status of shipment.

pickup_state

delivery_state

array of strings

Search by current delivery status of shipment.

delivery_state

warehouse_state

array of strings

For eFulfilment only. Search by current warehouse status of shipment.

warehouse_state

origin_country_alpha2

array of strings

Search by the shipment origin country code: Alpha-2 format (ISO 3166-1).

origin_country_alpha2

destination_country_alpha2

array of strings

Search by shipment destination country code: Alpha-2 format (ISO 3166-1).

destination_country_alpha2

return

string

Search by shipment whether the shipment is return shipment or not.

Responses

200list of shipments

422invalid filter param