GET /tracking
The Tracking service retrieves tracking statuses for a single or multiple DHL Express Shipments
Servers
- https://api-mock.dhl.com/mydhlapi
- https://express.api.dhl.com/mydhlapi/test
- https://express.api.dhl.com/mydhlapi
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Plugin-Version |
String | No |
Please provide version of the plugin (applicable to 3PV only) |
Accept-Language |
String | No |
Format {3-character language code} Default value: "eng" |
Shipping-System-Platform-Version |
String | No |
Please provide version of the shipping platform (applicable to 3PV only) |
Webstore-Platform-Version |
String | No |
Please provide version of the webstore platform (applicable to 3PV only) |
Message-Reference-Date |
String | No |
Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2 |
Webstore-Platform-Name |
String | No |
Please provide name of the webstore platform (applicable to 3PV only) |
Shipping-System-Platform-Name |
String | No |
Please provide name of the shipping platform(applicable to 3PV only) |
Message-Reference |
String | No |
Please provide message reference |
Plugin-Name |
String | No |
Please provide name of the plugin (applicable to 3PV only) |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pieceTrackingNumber[] |
Array | No |
DHL Express shipment piece tracking number |
levelOfDetail |
String | No |
Possible values:
Default value: "shipment" |
shipmentReference |
String | No |
Shipment reference which was provided during the shipment label creation |
trackingView |
String | No |
Possible values:
Default value: "all-checkpoints" |
dateRangeFrom |
String | No |
When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the start of the period. |
dateRangeTo |
String | No |
When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the end of the period. |
shipperAccountNumber |
String | No |
Shipper DHL Express Account number under which the shipment label was created |
requestControlledAccessDataCodes |
Boolean | No |
Query parameter to request to return values of controlled access code fields in response. Possible values:
|
shipmentTrackingNumber[] |
Array | No |
DHL Express shipment identification number |
shipmentReferenceType |
String | No |
Shipment reference type which was provided during the shipment label creation |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.