[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

Query Parameters

cursor

string

A string representing the cursor value for the current page of results.

Example:

WzE3MTk5OTIwMzIzNTMsImE0NWQ5NDg5ODU4NzQzMjA5YjBjYjRlZjE3ZTBjNGVhIl0=

limit

integer

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

>= 1<= 200

Default:

100

Example:

100

keyword

string

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

Example:

RA123456789US

tracking_numbers

string

Tracking number of shipments. Use comma to separate multiple values (Example: RA123456789US,LE123456789US). Supports up to 50 tracking numbers.

Example:

RA123456789US,LE123456789US

slug

string

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

>= 1 characters

Example:

usps

Match pattern:

^[a-z0-9-]+$

transit_time

integer

Total delivery time in days.Show all...

Example:

origin

string

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

Example:

USA

Match pattern:

^[A-Z,]+$

destination

string

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

Example:

USA

Match pattern:

^[A-Z,]+$

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]+$

created_at_min

string

Start date and time of trackings created. AfterShip only stores data of 120 days. Please make sure the value of the parameter is properly escaped in URL encoding. (Defaults: 30 days ago, Example: 2013-03-15T16:41:56%2B08:00)

Example:

2013-03-15T16:41:56%2B08: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_max

string

End date and time of trackings created. Please make sure the value of the parameter is properly escaped in URL encoding. (Defaults: now, Example: 2013-04-15T16:41:56%2B08:00)

Example:

2013-03-15T16:41:56%2B08: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. Please make sure the value of the parameter is properly escaped in URL encoding.(Example: 2013-04-15T16:41:56%2B08:00)

Example:

2013-03-15T16:41:56%2B08: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_max

string

End date and time of trackings updated. Please make sure the value of the parameter is properly escaped in URL encoding.(Example: 2013-04-15T16:41:56%2B08:00)

Example:

2013-03-15T16:41:56%2B08: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}$

fields

string

List of fields to include in the response. Use comma for multiple values. Available options: title, order_id, tag, checkpoints. Example: title,order_id

Example:

title

Match pattern:

^[a-z0-9,]+$

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,]+$

courier_destination_country_iso3

string

Destination country/region 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,]+$

shipment_tags

string

Tags you added to your shipments to help categorize and filter them easily. Use a comma to separate multiple values (Example: a,b)

order_id

string

A globally-unique identifier for the order. Use comma for multiple values.(Example: 6845a095a27a4caeb27487806f058add,4845a095a27a4caeb27487806f058abc)

Example:

6845a095a27a4caeb27487806f058add

Headers

Content-Type

string

required

Content-Type

Allowed value:

application/json

Default:

application/json

Example:

application/json

Auth

Parameters