QUICKSTART
API Quick Start
Authentication
Rate Limit
Body Envelope
Request Errors
Try API Endpoints
CHANGELOG
Changelog
REFERENCE
API Overview
v4
Trackings
Get trackings
get
Create a tracking
post
Get a tracking
get
Update a tracking
put
Delete a tracking
delete
Retrack an expired tracking
post
Mark tracking as completed
post
Couriers
Get user activated couriers
get
Detect courier
post
Get all couriers
get
Last Checkpoints
Get last checkpoint
get
Notifications
Get tracking notification
get
Add a notification
post
Remove a notification
post
MODEL
Tracking
v4
Courier
v4
Checkpoint
v4
Notification
v4
ENUM
Additional Tracking Fields
Delivered Statuses
Delivered Sub-statuses
Slug Groups
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
Webhook Changelog
OTHERS
Supported Couriers
CSV Upload & FTP Auto-Fetch
SDK
Android SDK
iOS SDK
Java SDK
Node.js SDK
.NET SDK
Python SDK
Ruby Gem
PHP SDK
Golang SDK
Open Source
phone
email-verifier
Support
Contact Support

Tracking

Object describes the tracking information.

id
string

Tracking ID.

>= 1 characters
created_at
string

Tracking created date time.

>= 1 characters
updated_at
string

Date and time of the tracking last updated.

>= 1 characters
last_updated_at
string

Date and time the tracking was last updated.

tracking_number
string

Tracking number.

>= 1 characters
slug
string

Unique code of courier. Get courier here

>= 1 characters
active
boolean

Whether or not AfterShip will continue tracking the shipments. Value is false when tag (status) is Delivered, Expired, or further updates for 30 days since last update.

android
array[string or null]

Google cloud message registration IDs to receive the push notifications. Accept either array or comma separated as input.

custom_fields
object

Custom fields of the tracking.

customer_name
string or null

Customer name of the tracking.

delivery_time
integer or null

Total delivery time in days.Show all...

destination_country_iso3
string or null

Destination country of the tracking. ISO Alpha-3 (three letters). If you use postal service to send international shipments, AfterShip will automatically get tracking results from destination postal service based on destination country.

destination_raw_location
string or null

Shipping address that the shipment is shipping to.

courier_destination_country_iso3
string or null

Destination country of the tracking detected from the courier. ISO Alpha-3 (three letters). Value will be null if the courier doesn't provide the destination country.

emails
array[string]

Email address(es) to receive email notifications.

expected_delivery
string or null

Expected delivery date. Available format:

  • YYYY-MM-DD
  • YYYY-MM-DDTHH:MM:SS
  • YYYY-MM-DDTHH:MM:SS+TIMEZONE
>= 1 characters
ios
array[string]

Apple iOS device IDs to receive the push notifications. Accept either array or comma separated as input.

note
string or null

Text field for the note.

order_id
string or null

Text field for order ID.

order_id_path
string or null

Text field for order path.

order_date
string or null

Date and time of the order created

origin_country_iso3
string or null

Origin country of the tracking. ISO Alpha-3 (three letters).

>= 1 characters
shipment_package_count
number or null

Number of packages under the tracking.

shipment_pickup_date
string or null

Date and time the tracking was picked up.

>= 1 characters
shipment_delivery_date
string or null

Date and time the tracking was delivered.

>= 1 characters
shipment_type
string or null

Shipment type provided by carrier.

>= 1 characters
shipment_weight
number or null

Shipment weight provied by carrier.

shipment_weight_unit
string or null

Weight unit provied by carrier, either in kg or lb.

signed_by
string or null

Signed by information for delivered shipment.

smses
array[string]

Phone number(s) to receive sms notifications. The phone number(s) to receive sms notifications. Phone number should begin with + and Area Code before phone number. Comma separated for multiple values.

source
string

Source of how this tracking is added.

>= 1 characters
tag
string

Current status of tracking. (See tag definition)

Allowed values:
PendingInfoReceivedInTransitOutForDeliveryAttemptFailDeliveredAvailableForPickupExceptionExpired
subtag
string

Current subtag of tracking. (See subtag definition)

>= 1 characters
subtag_message
string

Normalized tracking message. (See subtag definition)

>= 1 characters
title
string

Title of the tracking.

>= 1 characters
tracked_count
number

Number of attempts AfterShip tracks at courier's system.

last_mile_tracking_supported
boolean

Indicates if the shipment is trackable till the final destination. Three possible values:

  • true
  • false
  • null
language
string or null

Store, customer, or order language of the tracking. ISO 639-1 Language Code

unique_token
string
deprecated

Deprecated

>= 1 characters
checkpoints
array[Checkpoint]

Array of checkpoint object describes the checkpoint information.

created_at
string

Date and time of the tracking created.

>= 1 characters
slug
string

The unique code of courier for this checkpoint message. Get courier slug here

>= 1 characters
checkpoint_time
string

Date and time of the checkpoint, provided by courier. Value may be:Show all...

>= 1 characters
location
string or null

Location info provided by carrier (if any)

>= 1 characters
city
string or null

City info provided by carrier (if any)

>= 1 characters
state
string or null

State info provided by carrier (if any)

>= 1 characters
zip
string or null

Location info (if any)

>= 1 characters
coordinates
array[number]

Deprecated as of March 2013

country_iso3
string or null

Country ISO Alpha-3 (three letters) of the checkpoint

country_name
string or null

Country name of the checkpoint, may also contain other location info.

message
string

Checkpoint message

>= 1 characters
tag
string

Current status of tracking. (See tag definition)

Allowed values:
PendingInfoReceivedInTransitOutForDeliveryAttemptFailDeliveredAvailableForPickupExceptionExpired
subtag
string

Current subtag of checkpoint. (See subtag definition)

>= 1 characters
subtag_message
string

Normalized checkpoint message. (See subtag message definition)

>= 1 characters
raw_tag
string

Checkpoint status provided by courier (if any)

>= 1 characters
subscribed_smses
array[string]

Phone number(s) subscribed to receive sms notifications. Comma separated for multiple values

subscribed_emails
array[string]

Email address(es) subscribed to receive email notifications. Comma separated for multiple values

return_to_sender
boolean

Whether or not the shipment is returned to sender. Value is true when any of its checkpoints has subtag Exception_010 (returning to sender) or Exception_011 (returned to sender). Otherwise value is false.

order_promised_delivery_date
string or null

Promised delivery date of an order in YYYY-MM-DD format.

delivery_type
string or null

Shipment delivery type

  • pickup_at_store
  • pickup_at_courier
  • door_to_door
pickup_location
string or null

Shipment pickup location for receiver

pickup_note
string or null

Shipment pickup note for receiver

courier_tracking_link
string or null

Official tracking URL of the courier (if any)

>= 1 characters
first_attempted_at
string or null

date and time of the first attempt by the carrier to deliver the package to the addressee Available format:

  • YYYY-MM-DDTHH:MM:SS
  • YYYY-MM-DDTHH:MM:SS+TIMEZONE
>= 1 characters
courier_redirect_link
string

Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier.

>= 1 characters
tracking_account_number
string or null

Account number of the shipper for a specific courier. Required by some couriers, such as dynamic-logistics

tracking_origin_country
string or null

Origin Country of the shipment for a specific courier. Required by some couriers, such as dhl

tracking_destination_country
string or null

Destination Country of the shipment for a specific courier. Required by some couriers, such as postnl-3s

tracking_key
string or null

Key of the shipment for a specific courier. Required by some couriers, such as sic-teliway

tracking_postal_code
string or null

The postal code of receiver's address. Required by some couriers, such as deutsch-post

tracking_ship_date
string or null

Shipping date in YYYYMMDD format. Required by some couriers, such as deutsch-post

tracking_state
string or null

Located state of the shipment for a specific courier. Required by some couriers, such as star-track-courier

on_time_status
string or null

Whether the tracking is delivered on time or not.

on_time_difference
number or null

The difference days of the on time.

order_tags
array[string]

The tags of the order.

aftership_estimated_delivery_date
object or null

Estimated delivery time of the shipment provided by AfterShip, indicate when the shipment should arrive. Please be noted that the whole aftership_estimated_delivery_date object will be available in February 2022.

estimated_delivery_date
string

The estimated arrival date of the shipment.

confidence_score
null or number

The reliability of the estimated delivery date based on the trend of the transit time for the similar delivery route and the carrier's delivery performance, range from 0.0 to 1.0 (Beta feature).

estimated_delivery_date_min
string

Earliest estimated delivery date of the shipment.

estimated_delivery_date_max
string

Latest estimated delivery date of the shipment.

order_number
string or null

The unique numeric identifier for the order for use by shop owner and customer. (will come into action from est. 24 Feb)

Example
preparing...