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.
Legacy fields
The existing fields, including tracking_origin_country_region, tracking_destination_country_region, 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 Fields | New Fields |
|---|---|
| tracking_origin_country_region | origin_country_region |
| tracking_destination_country_region | destination_country_region |
| tracking_postal_code | destination_postal_code |
| tracking_state | destination_state |
Additional fields Format
| Name | Format | Description |
|---|---|---|
| tracking_account_number | Up to 512 alphanumeric characters | The shipper’s carrier account number. |
| tracking_key | At least 1 alphanumeric character, including -, . and _ | A type of tracking credential required by some carriers. |
| tracking_ship_date | YYYYMMDD | The date the shipment was sent. |
| destination_postal_code | Up to 10 alphanumeric characters, including + and - and space | The postal code of the recipient’s address. |
| origin_country_region | 3 characters country/region code in ISO 3166-1 alpha-3 format. | The origin country/region of the shipment. |
| destination_country_region | 3 characters country/region code in ISO 3166-1 alpha-3 format. | The destination country/region of the tracking. |
| destination_state | At least 1 character | The state/province of the recipient’s address. |
| customers[x].phone_number | Phone number should begin with + and Area Code before phone number. Comma separated for multiple values. | The recipient's phone number(s) to receive sms notifications. |
Slugs that require additional fields
| Carrier | Slug | Required Fields |
|---|---|---|
| Endeavour Delivery | endeavour-delivery | destination_postal_code |
| GLS Spain | gls-spain | destination_postal_code |
| DIR | dirmensajeria | destination_country_region |
| DPD Local reference | interlink-express-reference | destination_postal_code |
| Associate Global Systems | agsystems | destination_postal_code |
| Capital Transport | capital | tracking_account_number |
| Arrow XL | arrowxl | destination_postal_code |
| Star Track Courier | star-track-courier | destination_state |
| BRT Bartolini(Sender Reference) | brt-it-sender-ref | tracking_account_number |
| NACEX Spain | nacex-spain-reference | tracking_account_number tracking_key |
| ARK Logistics | ark-logistics | destination_postal_code |
| LIEFERGRUN | liefergrun | destination_postal_code |
| DHL Supply Chain APAC | dhl-supplychain-apac | destination_country_region |
| Paper Express | paper-express | destination_postal_code |
| NACEX Spain | nacex-spain | destination_postal_code |
| TDG – The Delivery Group | thedeliverygroup | destination_postal_code |
| Mondial Relay | mondialrelay | destination_postal_code |
| APC Overnight Consignment Number | apc-overnight-connum | destination_postal_code |
| Palletways | palletways | destination_postal_code |
| GLS Netherlands | gls-netherlands | destination_postal_code |
| PostNL International 3S | postnl-3s | destination_postal_code |
| Packs | packs | destination_postal_code |
| Allied Express | alliedexpress | destination_postal_code |
| Tuffnells Parcels Express | tuffnells | destination_postal_code |
| Bomi Group | bomi | tracking_account_number |
| XDP Express | xdp-uk | destination_postal_code |
| ASM(GLS Spain) | asm | destination_postal_code |
| NACEX | nacex | tracking_account_number |
| Packaly | packaly | destination_postal_code |
| DKSH | dksh | destination_country_region |
| Amazon order | amazon-order | tracking_key |
| Gel Express Logistik | gel-express | destination_postal_code |
| Best Way Parcel | bestwayparcel | tracking_key |
| Dynamic Logistics | dynamic-logistics | tracking_account_number |
| Total Express | total-express | tracking_account_number |
| PostNL Domestic | postnl | destination_postal_code |
| My DynaLogic | mydynalogic | destination_postal_code |
| Mikropakket | mikropakket | destination_postal_code |
| TransMission | transmission-nl | destination_postal_code |
| WeShip | weship | destination_postal_code |
| EU Fleet Solutions | eu-fleet-solutions | destination_postal_code |
| B2C Europe | b2ceurope | destination_postal_code destination_country_region |
| Sonic Transportation & Logistics | sonictl | tracking_ship_date |
| Trunkrs | trunkrs | destination_postal_code |
| Envialia Reference | envialia-reference | destination_postal_code |
| Mikropakket Belgium | mikropakket-be | destination_postal_code |
| Blue Star | bluestar | destination_postal_code |
| International Seur API | international-seur-api | tracking_ship_date |
| XDP Express Reference | xdp-uk-reference | destination_postal_code |
| Vietnam Post | vnpost-api | tracking_ship_date |
| Tuffnells Parcels Express- Reference | tuffnells-reference | destination_postal_code |
| DB Schenker B2B | dbschenker-b2b | tracking_account_number |
| The Pallet Network | pallet-network | destination_postal_code |
| Spanish Seur | spanish-seur | customers[x].phone_number destination_postal_code |