DHL ACT Webservices
Introduction and prerequisites
Welcome to DHL Freight’s Tracking API WebService.
It provides API access to DHL
Freight’s Track & Trace ‘Active Tracing’ solution (at https://activetracing.dhl.com).
A prerequisite of using the AcT WebServices is that you must first have a registered ‘myACT’ Active Tracing login – your myACT login will be configured with your DHL Account Number(s), whereby all AcT WebService Responses will be limited to those shipments with matching DHL Account Number(s) configured against your myACT login. Please use this link to register an account if you do not already have an active ‘myACT’ account.
For full specifications please refer to DHL ACT documentation.
API specifications
The API gives access to:
- Shipment Details
- Latest Shipment Status & Location
- Full Tracking Event History (Shipment Level & Package Level)
- POD (Proof Of Delivery) documents (& some other documents available)
The API supports 5 operations:
- GetConsignmentsByIdentifier: can be used if the DHL Order-Code, ShipmentID, or Package-IDis known.
- GetConsignmentsByReference: can be used if an exact Customer Reference String of a shipment is known.
- GetConsignmentsByAccountNumbers: returns all shipments/events, based on Customer DHL Account Number(s), can be used with date/time-parameters.
- GetLatestEventByIdentifiers: returns Latest Status & Location for multiple Shipment IDs (not Customer References), no Shipment Details / Event History.
- GetEpodsSync: returns ePods (& some other documents possible) of shipments immediately (synchronous), suitable for up to 10 Shipment-IDs, per Request.
26-04-2024 - At this stage we do not have the infrastructure in place for scheduling the API calls. For that reason we have decided to implement only the GetConsignmentsByReference operation a this stage.
Tracking events expected
The following event / reason codes can be returned by the API:
| Event Code | Reason Code | Code | Event Description |
|---|---|---|---|
| ACT | 2 | ACT,2 | Consignment created |
| 64 | 0 | 64,0 | Collection arranged - OK |
| 48 | 0 | 48,0 | Loaded by customer ready for Collection |
| 15 | 501 | 15,501 | Out for Collection |
| 55 | 211 | 55,211 | Not Collected - consignor closed |
| 55 | 68 | 55,68 | Not Collected - customer not ready |
| 55 | 21 | 55,21 | Not Collected - customer refusal |
| 55 | 126 | 55,126 | Not Collected - customs issue |
| 55 | 240 | 55,240 | Not Collected - DHL refusal, goods not transportable |
| 55 | 241 | 55,241 | Not Collected - missing or wrong reference |
| 55 | 265 | 55,265 | Not Collected - other reasons |
| 55 | 294 | 55,294 | Not Collected - time issue |
| 55 | 20 | 55,20 | Not Collected - traffic jam |
| 55 | 266 | 55,266 | Not Collected - weather condition issue |
| 55 | 234 | 55,234 | Not Collected - wrong address |
| 13 | 0 | 13,0 | Collected |
| 24 | 0 | 24,0 | Shipped from terminal |
| 1 | 0 | 1,0 | Received at terminal |
| 20 | 126 | 20,126 | On hold - in customs clearance. |
| 12 | 0 | 12,0 | Customs cleared |
| 20 | 266 | 20,266 | Delayed during transport - bad weather. |
| 20 | 354 | 20,354 | Delayed during transport - bank holiday. |
| 20 | 270 | 20,270 | Exception occurred - Strike. |
| 7 | 0 | 7,0 | New shipping instruction - consignment cancelled by sender |
| 56 | 222 | 56,222 | New shipping instruction - shipment returned. |
| 1 | 21 | 1,21 | Arrival at destination |
| 20 | 208 | 20,208 | Shipment in warehouse – Awaiting delivery appointment |
| 20 | 209 | 20,209 | Shipment in warehouse – Delivery appointment booked |
| 20 | 13 | 20,13 | Shipment in warehouse - ready for self collection by consignee |
| 20 | 296 | 20,296 | Shipment in warehouse - waiting for consignee payment. |
| 24 | 628 | 24,628 | Direct delivery |
| 24 | 501 | 24,501 | Out for Delivery |
| 20 | 211 | 20,211 | Attempted DHL delivery - consignee closed |
| 56 | 211 | 56,211 | Attempted DHL delivery - consignee not met |
| 56 | 292 | 56,292 | Attempted DHL delivery - refused by consignee, COD/DAD problem. |
| 56 | 221 | 56,221 | Attempted DHL delivery - refused by consignee, wrong address information |
| 56 | 284 | 56,284 | Attempted DHL delivery - refused by consignee, wrong goods. |
| 56 | 611 | 56,611 | Attempted DHL delivery - refused by consignee. |
| 56 | 241 | 56,241 | Attempted DHL delivery - refused due to missing documents |
| 20 | 234 | 20,234 | Attempted DHL delivery - wrong consignee address |
| 40 | 702 | 40,702 | Loaded into ferry |
| 24 | 600 | 24,600 | Received by consignee |
| 21 | 234 | 21,234 | Shipment delivered - new delivery address following consignee instruction |
| 21 | 23 | 21,23 | Shipment delivered with exception - partly delivered |
| 21 | 600 | 21,600 | Shipment delivered with exception. |
| 21 | 0 | 21,0 | Delivered |