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

List tracking requests

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/tracking_requests \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "request_number": "ONEYSH9AME650500",
        "request_type": "bill_of_lading",
        "scac": "ONEY",
        "created_at": "2023-11-07T05:31:56Z",
        "ref_numbers": [
          "<string>"
        ],
        "tags": [
          "<string>"
        ],
        "updated_at": "2023-11-07T05:31:56Z",
        "is_retrying": true,
        "retry_count": 123
      },
      "relationships": {
        "tracked_object": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "customer": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "company_name": "<string>"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

A search term to be applied against request_number and reference_numbers.

filter[status] · enum<string>

filter by status

Available options: created, pending, failed

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"

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

OK

data · Tracking Request · object[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes

included · (Account model · object | Shipping line model · object | object)[]

Account model

Shipping line model

Option 3

Show child attributes