GET
/
tracking_requests

Authorizations

Authorization
string
headerrequired

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Query Parameters

q
string
deprecated

A search term to be applied against request_number and reference_numbers.

filter[status]
enum<string>

filter by status

Available options:
created,
pending,
failed
filter[scac]
string

filter by shipping line scac

filter[created_at][start]
string

filter by tracking_requests created_at after a certain ISO8601 timestamp

filter[created_at][end]
string

filter by tracking_requests created_at before a certain ISO8601 timestamp

include
string

Comma delimited list of relations to include. 'tracked_object' is included by default.

page[number]
integer
page[size]
integer
filter[request_number]
string

filter by request_number

Response

200 - application/json
data
object[]
links
object
meta
object
included
object[]

Was this page helpful?

Resume tracking a shipmentCreate a tracking request