There are additional fields like "tracking_account_number" and "tracking_key" that certain carriers need to authenticate your API request. Find the full list here.

Some carriers need to provide some additional information of the tracking (to ensure that you are really the owner of the tracking information) in addition to the tracking number. tracking_account_number and tracking_key represent the log in information and API key that the specific carrier may need to authenticate. These two fields are handled differently by specific carriers.

Name

Format

Description

tracking_account_number

Up to 512 alphanumeric characters

The account number of carrier service.

tracking_postal_code

Up to 8 alphanumeric characters, including + and - and space

The postal code of the tracking.

tracking_ship_date

YYYYMMDD

The shipping date of the tracking.

tracking_key

At least 1 alphanumeric character, including -, . and _

The API key of carrier service.

tracking_origin_county

3 characters country code in ISO 3166-1 alpha-3 format.

The origin country of the tracking.

tracking_destination_country

3 characters country code in ISO 3166-1 alpha-3 format.

The destination country of the tracking.

tracking_state

At least 1 character

The state of the tracking.