Object describes the tracking information.
Tracking ID.
Tracking created date time.
Date and time of the tracking last updated.
Date and time the tracking was last updated.
Tracking number.
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.
Custom fields of the tracking.
Customer name of the tracking.
Total delivery time in days.Show all...
The ISO Alpha-3 code (3 letters) for the destination country/region. E.g. USA for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Shipping address that the shipment is shipping to.
Destination country/region 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.
Email address(es) to receive email notifications.
Expected delivery date. Available format:
Text field for the note.
A globally-unique identifier for the order.
The URL for the order in your system or store.
Date and time of the order created
The ISO Alpha-3 code (3 letters) for the origin country/region. E.g. USA for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Number of packages under the tracking.
Date and time the tracking was picked up.
Date and time the tracking was delivered.
The carrier service type for the shipment.
Shipment weight provied by carrier.
Weight unit provied by carrier, either in
kg
or lb
.
Signed by information for delivered shipment.
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 of how this tracking is added.
Current status of tracking. (See tag definition)
By default this field shows the tracking_number
, but you can customize it as you wish with any info (e.g. the order number).
Number of attempts AfterShip tracks at courier's system.
Indicates if the shipment is trackable till the final destination. Three possible values:
The recipient’s language. If you set up AfterShip notifications in different languages, we use this to send the recipient tracking updates in their preferred language.
Deprecated
Array of checkpoint object describes the checkpoint information.
Date and time of the tracking created.
The unique code of courier for this checkpoint message. Get courier slug here
Date and time of the checkpoint, provided by courier. Value may be:Show all...
Location info provided by carrier (if any)
City info provided by carrier (if any)
State info provided by carrier (if any)
Location info (if any)
Deprecated as of March 2013
Country/Region ISO Alpha-3 (three letters) of the checkpoint
Country/Region name of the checkpoint, may also contain other location info.
Checkpoint message
Current status of tracking. (See tag definition)
Checkpoint status provided by courier (if any)
Phone number(s) subscribed to receive sms notifications. Comma separated for multiple values
Email address(es) subscribed to receive email notifications. Comma separated for multiple values
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
.
Promised delivery date of an order in YYYY-MM-DD
format.
Shipment delivery type
Shipment pickup location for receiver
Shipment pickup note for receiver
Official tracking URL of the courier (if any)
date and time of the first attempt by the carrier to deliver the package to the addressee Available format:
Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier.
Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on additional tracking fields for more details.
Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on additional tracking fields for more details.
Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on additional tracking fields for more details.
Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on additional tracking fields for more details.
Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on additional tracking fields for more details.
Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on additional tracking fields for more details.
Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on additional tracking fields for more details.
Whether the tracking is delivered on time or not.
The difference days of the on time.
The tags of the order.
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.
The estimated arrival date of the shipment.
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).
Earliest estimated delivery date of the shipment.
Latest estimated delivery date of the shipment.
A unique, human-readable identifier for the order.
The latest estimated delivery date. May come from the carrier, AfterShip AI, or based on your custom settings. This can appear in 1 of 3 formats based on the data received.
YYYY-MM-DD
YYYY-MM-DDTHH:mm:ss
YYYY-MM-DDTHH:mm:ssZ
The format of the EDD. Either a single date or a date range.
The source of the EDD. Either the carrier, AfterShip AI, or based on your custom EDD settings.
The latest EDD time.
For a date range EDD format, the date and time for the lower end of the range.
For a date range EDD format, the date and time for the upper end of the range.
Used to add tags to your shipments to help categorize and filter them easily.
The courier connection id tells which carrier account you’ve used to handle a shipment so we can track it.
The next couriers get the second carrier information from user or AfterShip.
Unique code of courier. Get courier here
Tracking number.
Source of next couriers.
preparing...