Here is the Aftership tracking object containing all the fields to retrieve tracking information of single or multiple trackings.

Name

Type

Description

id

String

Tracking ID.

created_at

String

Tracking created date time.

updated_at

String

Date and time of the tracking last updated.

last_updated_at

String

Date and time the tracking was last updated.

tracking_number

String

Tracking number.

slug

String

Unique code of courier. Get courier here

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

[String]

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

Customer name of the tracking.

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.

destination_country_iso3

String

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.

courier_destination_country_iso3

String

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

[String]

Email address(es) to receive email notifications.

expected_delivery

String

Expected delivery date.
Available format:

  • YYYY-MM-DD
  • YYYY-MM-DDTHH:MM:SS
  • YYYY-MM-DDTHH:MM:SS+TIMEZONE

ios

[String]

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

note

String

Text field for the note.

order_id

String

Text field for order ID.

order_id_path

String

Text field for order path.

order_date

String

Date and time of the order created

origin_country_iso3

String

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

shipment_package_count

Number

Number of packages under the tracking.

shipment_pickup_date

String

Date and time the tracking was picked up.

shipment_delivery_date

String

Date and time the tracking was delivered.

shipment_type

String

Shipment type provided by carrier.

shipment_weight

Number

Shipment weight provied by carrier.

shipment_weight_unit

String

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

signed_by

String

Signed by information for delivered shipment.

smses

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

tag

[String]
Enum

Current status of tracking. (See tag definition)

subtag

String

Current subtag of tracking. (See subtag definition)

subtag_message

String

Normalized tracking message. (See subtag definition)

title

String

Title of the tracking.

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

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

unique_token

String

Deprecated

checkpoints

[Checkpoint]

Array of checkpoint object describes the checkpoint information.

subscribed_smses

[String]

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

subscribed_emails

[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). Otherwis value is false.

order_promised_delivery_date

String

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

delivery_type

String

Shipment delivery type

  • pickup_at_store
  • pickup_at_courier
  • door_to_door

pickup_location

String

Shipment pickup location for receiver

pickup_note

String

Shipment pickup note for receiver

courier_tracking_link

String

Official tracking URL of the courier (if any)

first_attempted_at

String

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

courier_redirect_link

String

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

tracking_account_number

String

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

tracking_origin_country

String

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

tracking_destination_country

String

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

tracking_key

String

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

tracking_postal_code

String

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

tracking_ship_date

String

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

tracking_state

String

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

on_time_status

String, Null

Whether the tracking is delivered on time or not.

on_time_difference

Number, Null

The difference days of the on time.