Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-208342528.4 KB
Tracking Requests

List tracking requests

Returns a list of your tracking requests. The tracking requests are returned sorted by creation date, with the most recent tracking request appearing first.

get/tracking_requests

Query parameters

qstring

A search term to be applied against request_number and reference_numbers.

filter[request_number]string

filter by request_number

filter[status]'created' | 'pending' | 'failed'
Example:created

filter by status

filter[scac]string
Example:MSCU

filter by shipping line scac

filter[created_at][start]string date-time
Example:2020-04-28T22:59:15Z

filter by tracking_requests created_at after a certain ISO8601 timestamp

filter[created_at][end]string date-time
Example:2020-04-28T22:59:15Z

filter by tracking_requests created_at before a certain ISO8601 timestamp

filter[updated_at][start]string date-time
Example:2020-04-28T22:59:15Z

filter by tracking_requests updated_at after a certain ISO8601 timestamp

filter[updated_at][end]string date-time
Example:2020-04-28T22:59:15Z

filter by tracking_requests updated_at before a certain ISO8601 timestamp

includestring

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

page[number]integer
page[size]integer

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "request_number": "ONEYSH9AME650500",
        "request_type": "bill_of_lading",
        "scac": "ONEY"
      }
    }
  ]
}