Skip to main content
GET
List tracking requests

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Query Parameters

q
string

A search term to be applied against request_number and reference_numbers.

filter[request_number]
string

filter by request_number

filter[status]
enum<string>

filter by status. pending matches requests with status pending; any value other than created, failed or cancelled is treated as pending.

Available options:
created,
pending,
failed,
cancelled
Example:

"created"

filter[scac]
string

filter by shipping line scac

Example:

"MSCU"

filter[created_at][start]
string<date-time>

filter by tracking_requests created_at after a certain ISO8601 timestamp

Example:

"2020-04-28T22:59:15Z"

filter[created_at][end]
string<date-time>

filter by tracking_requests created_at before a certain ISO8601 timestamp

Example:

"2020-04-28T22:59:15Z"

filter[updated_at][start]
string<date-time>

filter by tracking_requests updated_at after a certain ISO8601 timestamp

Example:

"2020-04-28T22:59:15Z"

filter[updated_at][end]
string<date-time>

filter by tracking_requests updated_at before a certain ISO8601 timestamp

Example:

"2020-04-28T22:59:15Z"

include
string

Comma-delimited list of relationships to include. Accepted values: tracked_object, customer, and user. tracked_object is included by default.

page[number]
integer
page[size]
integer

Response

OK

data
Tracking Request · object[]

Pagination links. Each value is an absolute URL. self repeats the request URL as sent, including its query string and its encoding. current, first, prev, next, and last repeat the request's query parameters, with page[number] and page[size] in unencoded brackets.

meta
meta · object
included
Account model · object · Shipping line model · object · object · object[]