Detect courier - AfterShip Tracking API

Return a list of matched couriers based on tracking number format and selected couriers or a list of couriers.

[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)

Request

Security: API Key

Headers

Content-Type

string

required

Content-Type

Allowed value:

application/json

Default:

application/json

Example:

application/json

Body

Detect courier request

tracking_number

string

required

Tracking number of a shipment.

Example:

RA123456879US

slug

array[string]

If not specified, Aftership will automatically detect the courier based on the tracking number format and your selected couriers. Use array to input a list of couriers for auto detect. Cannot be used with slug_group at the same time.

tracking_postal_code

string

The postal code of receiver's address. Required by some couriers. Refer to this page for more details

tracking_ship_date

string

Shipping date in YYYYMMDD format. Required by some couriers. Refer to this page for more details

tracking_account_number

string

Account number of the shipper for a specific courier. Required by some couriers. Refer to this page for more details

tracking_key

string

Key of the shipment for a specific courier. Required by some couriers. Refer to this page for more details

tracking_origin_country

string

Origin Country/Region of the shipment for a specific courier. Required by some couriers.

tracking_destination_country

string

Destination Country/Region of the shipment for a specific courier. Required by some couriers. Refer to this page for more details

tracking_state

string

State of the destination shipping address of the shipment. Required by some couriers.

slug_group

string

Slug group is a group of slugs which belong to same courier. For example, when you inpit "fedex-group" as slug_group, AfterShip will detect the tracking with "fedex-uk", "fedex-fims", and other slugs which belong to "fedex". It cannot be used with slug at the same time. (See slug_groups definition)

url url url url url url url url url url url url url url url url url url url url url url url url url

Allowed values:

amazon-groupfedex-grouptoll-grouptaqbin-grouptnt-groupcj-grouphermes-groupdpd-groupgls-groupdhl-groupfastway-groupasendia-group

origin_country_iso3

string

Enter ISO Alpha-3 (three letters) to specify the origin of the shipment (e.g. USA for United States).

destination_country_iso3

string

Enter ISO Alpha-3 (three letters) to specify the destination of the shipment (e.g. USA for United States).