Courier - AfterShip Tracking API Docs

Courier objectShow all...

slug

string

Unique code of courier. Get the slugs from here.

Example:

postnl-3s

Match pattern:

^[a-z0-9-]+$

name

string

Name of courier

Example:

PostNL International 3S

phone

string or null

Contact phone number of courier

Example:

+31 (0)900 0990

other_name

string or null

Other name of courier

Example:

TNT Post parcel service United Kingdom

web_url

string<uri> or null

Website link of courier

Example:

http://www.postnl.nl/voorthuis/

required_fields

array[string] or null

The extra fields need for tracking, such as tracking_account_number, tracking_postal_code, tracking_ship_date, tracking_key, tracking_destination_country_region

>= 0 items

Allowed values:

tracking_account_numberdestination_postal_codedestination_statetracking_keyorigin_country_regiondestination_country_regiontracking_ship_date

optional_fields

array[string] or null

The extra fields which are optional for tracking. Basically it's the same as required_fields, but the difference is that only some of the tracking numbers require these fields.

>= 0 items

Allowed values:

tracking_account_numberdestination_postal_codedestination_statetracking_keyorigin_country_regiondestination_country_regiontracking_ship_date

default_language

string or null

Default language of tracking results

>= 2 characters<= 2 characters

Example:

Match pattern:

^[a-z]{2}$

support_languages

array[string] or null

Other supported languages

>= 1 items

service_from_country_regions

array[string] or null

Country/Region code (ISO Alpha-3) where the courier provides service

>= 1 items

credentials

object

Refers to the authentication details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to create a carrier connection. The content varies by carrier.

fields

array[credential_field]

Through this field, users can get the specific authentication information needed when creating a courier connection to one specific carrier, such as API keys, usernames, and passwords. Each field includes properties like name, data type, and whether it's required.

{ "slug": "ups-api", "name": "UPS", "phone": "+1 800 742 5877", "other_name": "United Parcel Service", "web_url": "https://www.ups.com", "required_fields": [], "optional_fields": [], "default_language": "en", "support_languages": [ "en" ], "service_from_country_regions": [], "credentials": { "fields": [ { "name": "user_id", "type": "string", "required": true }, { "name": "password", "type": "string", "required": true }, { "name": "access_license_number", "type": "string", "required": true } ] } }