QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Versioning
Rate Limit
Body Envelope
Request Errors
Try API Endpoints
CHANGELOG
Changelog
Migration Guide
REFERENCE
API Overview
Trackings
Get trackings
get
Create a tracking
post
Get a tracking by ID
get
Update a tracking by ID
put
Delete a tracking by ID
delete
Retrack an expired tracking by ID
post
Mark tracking as completed by ID
post
Get a tracking (Legacy)
get
Update a tracking (Legacy)
put
Delete a tracking (Legacy)
delete
Retrack an expired tracking (Legacy)
post
Mark tracking as completed (Legacy)
post
Couriers
Get user activated couriers
get
Detect courier
post
Get all couriers
get
Last Checkpoints
Get last checkpoint by tracking ID
get
Get last checkpoint (Legacy)
get
Notifications
Get tracking notification by tracking ID
get
Add a notification by tracking ID
post
Remove a notification by tracking ID
post
Get tracking notification (Legacy)
get
Add a notification (Legacy)
post
Remove a notification (Legacy)
post
Estimated delivery date
Batch prediction for the Estimated Delivery Date
post
MODEL
Tracking
Courier
Checkpoint
Notification
ENUM
Additional Tracking Fields
Delivery Statuses
Delivery Sub-statuses
Slug Groups
Events
Confidence Codes
Webhook
Webhook Overview
Webhook Versioning
Webhook Specifications
Webhook Signature
Webhook OAuth 2.0
Webhook Outgoing IPs
Webhook Changelog
OTHERS
Supported Couriers
CSV Upload & CSV Auto-Fetch
Shipment CSV Export
Order CSV Export
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

Additional Tracking Fields

There are additional fields like "tracking_account_number" and "tracking_key" that certain carriers need to authenticate your API request. Find the full list here.


Some carriers need to provide some additional information of the tracking (to ensure that you are really the owner of the tracking information) in addition to the tracking number. tracking_account_number and tracking_key represent the log in information and API key that the specific carrier may need to authenticate. These two fields are handled differently by specific carriers.

The existing fields, including tracking_origin_country, tracking_destination_country, tracking_postal_code, and tracking_state, have been marked as legacy fields and have been replaced by the new fields. However, the legacy fields are still available. Check the details below.

Legacy FieldsNew Fields
tracking_origin_countryorigin_country_iso3
tracking_destination_countrydestination_country_iso3
tracking_postal_codedestination_postal_code
tracking_statedestination_state
NameFormatDescription
tracking_account_numberUp to 512 alphanumeric charactersThe shipper’s carrier account number.
tracking_keyAt least 1 alphanumeric character, including -, . and _A type of tracking credential required by some carriers.
tracking_ship_dateYYYYMMDDThe date the shipment was sent.
destination_postal_codeUp to 10 alphanumeric characters, including + and - and spaceThe postal code of the recipient’s address.
origin_country_iso33 characters country/region code in ISO 3166-1 alpha-3 format.The origin country/region of the shipment.
destination_country_iso33 characters country/region code in ISO 3166-1 alpha-3 format.The destination country/region of the tracking.
destination_stateAt least 1 characterThe state/province of the recipient’s address.
CarrierSlugRequired Fields
Mikropakketmikropakketdestination_postal_code
ARK Logisticsark-logisticsdestination_postal_code
Yodel Internationalyodel-internationaldestination_postal_code
Capital Transportcapitaltracking_account_number
Geodis E-spacegeodis-espacetracking_key
Best Way Parcelbestwayparceltracking_key
NACEX Spainnacex-spain-referencetracking_account_number
tracking_key
TFM Xpresstfmdestination_postal_code
DKSHdkshdestination_country_iso3
TransMissiontransmission-nldestination_postal_code
Blue Starbluestardestination_postal_code
DXdxdestination_postal_code
EU Fleet Solutionseu-fleet-solutionsdestination_postal_code
Envialia Referenceenvialia-referencedestination_postal_code
GLS Spaingls-spaindestination_postal_code
PostNL International 3Spostnl-3sdestination_country_iso3
destination_postal_code
My DynaLogicmydynalogicdestination_postal_code
The Pallet Networkpallet-networkdestination_postal_code
International Seur APIinternational-seur-apitracking_ship_date
Amazon orderamazon-ordertracking_key
BRT Bartolini(Sender Reference)brt-it-sender-reftracking_account_number
Allied Expressalliedexpressdestination_postal_code
Packspacksdestination_postal_code
Star Track Courierstar-track-courierdestination_state
Total Expresstotal-expresstracking_account_number
ParcelPoint Pty Ltdparcelpointtracking_key
C.H. Robinson Worldwide, Inc.chrobinsontracking_key
Bomi Groupbomitracking_account_number
Gel Express Logistikgel-expressdestination_postal_code
Arrow XLarrowxldestination_postal_code
Tuffnells Parcels Express- Referencetuffnells-referencedestination_postal_code
APC Overnight Consignment Numberapc-overnight-connumdestination_postal_code
Colis Privécolis-privedestination_postal_code
Mondial Relaymondialrelaydestination_postal_code
Endeavour Deliveryendeavour-deliverydestination_postal_code
DPD Local referenceinterlink-express-referencedestination_postal_code
DB Schenker B2Bdbschenker-b2btracking_account_number
Palletwayspalletwaysdestination_postal_code
Mikropakket Belgiummikropakket-bedestination_postal_code
Trunkrstrunkrsdestination_postal_code
AB Custom Groupabcustomdestination_postal_code
XDP Expressxdp-ukdestination_postal_code
Yodel Domesticyodeldestination_postal_code
Dynamic Logisticsdynamic-logisticstracking_account_number
GLS Netherlandsgls-netherlandsdestination_postal_code
NACEX Spainnacex-spaindestination_postal_code
Tuffnells Parcels Expresstuffnellstracking_account_number
destination_postal_code
NACEXnacextracking_account_number
B2C Europeb2ceuropedestination_postal_code
destination_country_iso3
DHL Supply Chain APACdhl-supplychain-apacdestination_country_iso3
TDG – The Delivery Groupthedeliverygroupdestination_postal_code
XDP Express Referencexdp-uk-referencedestination_postal_code
PostNL Domesticpostnldestination_postal_code
WeShipweshipdestination_postal_code
Vietnam Postvnpost-apitracking_ship_date
Paper Expresspaper-expressdestination_postal_code
ASM(GLS Spain)asmdestination_postal_code