GET
/
tracking_requests
curl --request GET \
  --url https://api.terminal49.com/v2/tracking_requests \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "tracking_request",
      "attributes": {
        "request_number": "ONEYSH9AME650500",
        "ref_numbers": [
          "<string>"
        ],
        "tags": [
          "<string>"
        ],
        "status": "pending",
        "failed_reason": "booking_cancelled",
        "request_type": "bill_of_lading",
        "scac": "ONEY",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_retrying": true,
        "retry_count": 123
      },
      "relationships": {
        "tracked_object": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "shipment"
          }
        },
        "customer": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "party"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "container",
      "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
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
Example:

"created"

​
filter[scac]
string

filter by shipping line scac

Example:

"MSCU"

​
filter[created_at][start]
string

filter by tracking_requests created_at after a certain ISO8601 timestamp

Example:

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

​
filter[created_at][end]
string

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
object[]
​
links
object
​
meta
object
​
included
object[]

Was this page helpful?

Suggest editsRaise issue
Resume tracking a shipmentCreate a tracking request