List tracking requests

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

{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "code": "<string>",
      "status": "<string>",
      "meta": {
        "tracking_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ]
}

GET

tracking_requests

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

{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "code": "<string>",
      "status": "<string>",
      "meta": {
        "tracking_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ]
}

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

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

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"

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 relations to include. 'tracked_object' is included by default.

page[number]

integer

page[size]

integer

Response

data

Tracking Request · object[]

Show child attributes

data.id

string<uuid>

required

data.type

enum<string>

required

Available options:

tracking_request

data.attributes

object

Show child attributes

data.attributes.request_number

string

required

Example:

"ONEYSH9AME650500"

data.attributes.status

enum<string>

required

Available options:

pending,

awaiting_manifest,

created,

failed,

tracking_stopped

data.attributes.request_type

enum<string>

required

Available options:

bill_of_lading,

booking_number,

container

Example:

"bill_of_lading"

data.attributes.scac

string

required

Required string length: 4

Example:

"ONEY"

data.attributes.created_at

string<date-time>

required

data.attributes.ref_numbers

string[] | null

data.attributes.tags

string[]

data.attributes.failed_reason

enum<string> | null

If the tracking request has failed, or is currently failing, the last reason we were unable to complete the request

Available options:

booking_cancelled,

duplicate,

expired,

internal_processing_error,

invalid_number,

not_found,

retries_exhausted,

shipping_line_unreachable,

unrecognized_response,

data_unavailable,

data.attributes.updated_at

string<date-time>

data.attributes.is_retrying

boolean

data.attributes.retry_count

integer | null

How many times T49 has attempted to get the shipment from the shipping line

data.relationships

object

Show child attributes

data.relationships.tracked_object

object

Show child attributes

data.relationships.tracked_object.data

object

Show child attributes

data.relationships.tracked_object.data.id

string<uuid>

data.relationships.tracked_object.data.type

enum<string>

Available options:

shipment

data.relationships.customer

object

Show child attributes

data.relationships.customer.data

object

Show child attributes

data.relationships.customer.data.id

string<uuid>

data.relationships.customer.data.type

enum<string>

Available options:

party

links

links · object

Show child attributes

links.last

string<uri>

links.next

string<uri>

links.prev

string<uri>

links.first

string<uri>

links.self

string<uri>

Getting Started

In Depth Guides

Useful Info

Shipments

Tracking Requests

Webhooks

Webhook Notifications

Containers

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Parties

List tracking requests

Authorizations

Query Parameters

Response