v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
Trackings

List all Trackings

Retrieve a list of trackings available with your account.

Required authorization scope: public.track_3p:read

Note: This endpoint requires an advanced scope. You can enable advanced scopes when creating or editing your API connection.

Note: Calls to this endpoint count towards your API usage allowance. You can monitor your current usage in the Subscription section of your account.

get/2024-09/trackings

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

origin_country_alpha2string

Filter records by origin country using alpha2 format

destination_country_alpha2string

Filter records by destination country using alpha2 format

sourcestring

Filter records by the source of record. Only "easyship" and "external" that are acceptable

tracking_state'created' | 'active' | 'pending' | 'completed' | 'overwritten_by_admin'

Filter records by the state of the tracking.

Response

list of trackings