User Guide for Track
Define the WebHook interface
- You can either write your own or visit the webhook.site (opens new window) site to use the free WebHook interface for verification.
- Regardless of the method chosen, you need to save the WebHook interface address in the API system. This step requires you to contact us to configure the relevant paths.
- For details on defining, configuring, and testing WebHooks, please refer to the WebHook Usage Guide.
Register a Package
- Please ensure that you have successfully registered an API account. If you haven't, please visit this link Start Tracking (opens new window).
Listening to the WebHook interface to obtain push information.
- Upon successful registration of the logistics number for the first time, tracking results will be returned within a few seconds (there may be a delay of more than 5 minutes due to network, carrier service, etc.).
- If you receive the following push results, it indicates that automatic tracking of logistics information has been successful and the push is successful:
{
"gigaTrackingNumber": "GCL3928239708621",
"param": "test123",
"tag": "custom tag",
"exceptionFlag": "S",
"shipFrom": "BRASELTON,GA,US",
"shipTo": "WEATHERLY,PA,US",
"readyPickUpDate": 1701687628000,
"actualPickUpDate": 1701687628000,
"readyDeliveryDate": 1701687628000,
"actualDeliveryDate": 1701687628000,
...
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
Considerations
Unique identifier
- gigaTrackingNumber serves as the unique identifier for the data. Additionally, for Express business, gigaTrackingNumber is generated by combining
trackingNumber,carrierKey, andbizUniqId. For Truck business, gigaTrackingNumber is generated by combiningtrackingNumberandcarrierKey.
additional tracking parameters
Some carriers require additional parameters to track changes in waybills, please refer to the following content:
| CARRIER | CARRIER_KEY | TYPE | Example Parameter Format |
|---|---|---|---|
| Allied Express Transport | - | Postal Code | 2487 |
| A TU HORA EXPRESS | - | Postal Code | 28224 |
| Bpost | - | Postal Code | 123456 |
| Colis Prive(Colis Privé) | - | Postal Code | 92000 |
| DX | - | Postal Code | 12345 |
| DHL Supply Chain APAC | - | Country Code(Two Digits) | US |
| Fietskoeriers | - | Postal Code | 12345 |
| Furdeco | - | Postal Code | LD3 8NL |
| Gebrüder Weiss (GW) | - | Postal Code、City 、Country 、Sender、Recipient | 21000、biejing、CN、zhangsan、lisi |
| GLS Spain (National) | - | Postal Code | 123456 |
| GLS (NL) | - | Postal Code | 12345 |
| GLS Portugal (National) | - | Postal Code | 20740 |
| Inpost (ES) | - | Postal Code | 12345 |
| J&T Express (MX) | - | Mobile Ending (Four Digits) | 6172 |
| J&T Express (TH) | - | Mobile Ending (Four Digits) | 9996 |
| J&T Express (VN) | - | Mobile Ending (Four Digits) | 0153 |
| Mondial Relay | - | Postal Code | 123456 |
| Nacex | - | Client | 12345 |
| Nacex | - | Origin office | 1234 |
| Paack | - | Postal Code | 12345 |
| Pall-Ex (UK) | - | Postal Code | CO14 8LF |
| Palletways | - | Postal Code | DD5 3BG |
| PostNL | - | Country Code(Two Digits)+Postal Code | FR-12345 |
| Ryder | - | Postal Code | 88888 |
| GLS | carrier_069 | Postal Code | 88888 |
| XDP | carrier_099/carrier_058 | Postal Code | 3078CM |
| Tuffnells | - | Postal Code | S27 1BZ |
| Walkers Transport | - | Postal Code | TR197BG |
| CN | - | Mobile Ending (Four Digits) | 5678 |
← Introduction WebHook →