Courier - AfterShip Docs

Courier object

[url](../../docs/enum/additional-tracking-fields.md)[url](../../docs/enum/delivery-sub-statuses.md)[url](../../docs/enum/delivery-statuses.md)[url](../../docs/enum/slug-groups.md)[url](../../model/resource/tracking.v4.json)[url](../../model/resource/checkpoint.v4.json)[url](../../model/resource/courier.v4.json)[url](../../model/resource/notification.v4.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.v4.json/paths/~1trackings/get)[url](../../reference/api.v4.json/paths/~1trackings/post)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.v4.json/paths/~1couriers/get)[url](../../reference/api.v4.json/paths/~1couriers~1detect/post)[url](../../reference/api.v4.json/paths/~1couriers~1all/get)[url](../../reference/api.v4.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.v4.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.v4.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.v4.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)

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

Contact phone number of courier

Example:

+31 (0)900 0990

other_name

string

Other name of courier

Example:

TNT Post parcel service United Kingdom

web_url

string<uri>

Website link of courier

Example:

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

required_fields

array[string]

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

>= 0 items

Allowed values:

tracking_account_numbertracking_postal_codetracking_ship_datetracking_keytracking_origin_countytracking_destination_countrytracking_state

optional_fields

array[string]

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_numbertracking_postal_codetracking_ship_datetracking_keytracking_origin_countytracking_destination_countrytracking_state

default_language

string

Default language of tracking results

>= 2 characters<= 2 characters

Example:

Match pattern:

^[a-z]{2}$

support_languages

array[string]

Other supported languages

>= 1 items

service_from_country_iso3

array[string]

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

>= 1 items