v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Shipments

List all Trackings

Retrieve the most recent status for a shipment and a history of all previous checkpoints.

Required authorization scope: public.track:read

get/2024-09/shipments/trackings

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

easyship_shipment_idstring[]

Easyship Shipment ID provided when creating the shipment.

platform_order_numberstring[]

Order number on the sales platform. You can choose to use either easyship_shipment_id or platform_order_number.

include_checkpointsboolean

Include checkpoints in the response.

Response

list of shipment trackings with checkpoints