Get trackings - AfterShip Docs

Get tracking results of multiple trackings.

[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)

Request

Security: API Key

Query Parameters

courier_destination_country_iso3

string

Destination country of trackings returned by courier. Use ISO Alpha-3 (three letters). Use comma for multiple values. (Example: USA,HKG)

Example:

USA

Match pattern:

^[A-Z,]+$

created_at_max

string

End date and time of trackings created. (Defaults: now, Example: 2013-04-15T16:41:56+08:00)

Example:

2013-03-15T16:41:56+08:00

Match pattern:

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

created_at_min

string

Start date and time of trackings created. AfterShip only stores data of 90 days.Show all...

Example:

2013-03-15T16:41:56+08:00

Match pattern:

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

delivery_time

number

Total delivery time in days.

Difference of 1st checkpoint time and delivered time for delivered shipments
Difference of 1st checkpoint time and current time for non-delivered shipments

Value as 0 for pending shipments or delivered shipment with only one checkpoint.

Example:

destination

string

Destination country of trackings. Use ISO Alpha-3 (three letters). Use comma for multiple values. (Example: USA,HKG)

Example:

USA

Match pattern:

^[A-Z,]+$

fields

string

List of fields to include in the response. Use comma for multiple values. Fields to include: title, order_id, tag, checkpoints, checkpoint_time, message, country_name Defaults: none, Example: title, order_id

Example:

title

Match pattern:

^[a-z0-9,]+$

keyword

string

Search the content of the tracking record fields: tracking_number, title, order_id, customer_name, custom_fields, emails, smses

Example:

RA123456789US

lang

string

Default: '' / Example: 'en' Support Chinese to English translation for china-ems and china-post only

>= 2 characters<= 2 characters

Example:

Match pattern:

^[a-z]{2}$

last_updated_at

string

Tracking last updated at

Example:

2013-03-15T16:41:56+08:00

Match pattern:

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

limit

number

Number of trackings each page contain. (Default: 100, Max: 200)

>= 1<= 200

Default:

100

Example:

100

origin

string

Origin country of trackings. Use ISO Alpha-3 (three letters). Use comma for multiple values. (Example: USA,HKG)

Example:

USA

Match pattern:

^[A-Z,]+$

page

number

Page to show. (Default: 1)

>= 1

Default:

Example:

return_to_sender

string

Select return to sender, the value should be true or false, with optional comma separated.

Example:

true

Match pattern:

^[a-z,]+$

slug

string

Unique courier code Use comma for multiple values. (Example: dhl,ups,usps)

>= 1 characters

Example:

usps

Match pattern:

^[a-z0-9-]+$

tag

string

Current status of tracking. Values include Pending, InfoReceived, InTransit, OutForDelivery, AttemptFail, Delivered, AvailableForPickup, Exception, Expired (See tag definition)

Allowed values:

PendingInfoReceivedInTransitOutForDeliveryAttemptFailDeliveredAvailableForPickupExceptionExpired

Example:

InTransit

Match pattern:

^[A-Za-z]+$

tracking_numbers

string

Tracking number of shipments. Use comma to separate multiple values (Example: RA123456789US,LE123456789US)

Example:

RA123456789US,LE123456789US

updated_at_max

string

End date and time of trackings updated. (Example: 2013-04-15T16:41:56+08:00)

Example:

2013-03-15T16:41:56+08:00

Match pattern:

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

updated_at_min

string

Start date and time of trackings updated. (Example: 2013-04-15T16:41:56+08:00)

Example:

2013-03-15T16:41:56+08:00

Match pattern:

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

Headers

Content-Type

string

required

Content-Type

Allowed value:

application/json

Default:

application/json

Example:

application/json