1. Overview
1.1 Brief
This document is mainly for users who use the Shipment Tracking API.
- The Shipment Tracking API provides up-to-the-minute shipment status reports. Users of this API can:
a. Retrieve tracking information for shipments.
b. Identify the Deutsche Post DHL (DPDHL) service provider involved with the shipment.
c. Verify DPDHL is using the correct delivery address. This can reduce the number of misdelivered shipments.
If you want to know more details, please refer to the Overview page of the website.
2. Registration Process
2.1 Sign up
- Website: https://developer.dhl.com/user/login?destination=/node/3
- Create a developer account – Click “Sign up here” button.
- Registered Customer - Click “sign in here”.
- Forgot password – Click “Forgot your password?”
- Create a developer account
- Type in the name, email, company name and other relevant information for registration
- CAPTCHA
- Click "Send" button
- After registration, it will jump to the following page. Meanwhile, the registered mailbox will receive an email notification from DHL API Developer Portal. Please set the password according to the email.
2.2 Get API Credential
- Method one: After registration, click “Apps” in the following page.
- Method two: After signing in, enter the website: https://developer.dhl.com/api-reference/shipment-tracking#get-started-section/
- Click “My Apps” under “User Guide”/ “Get Access” page.
- Click “+Create App” button in APPS Page.
- Fill in the “Create APP” Page
- Fill in “APP Name” and “Description” (Mandatory)
- ” API’s name”: choose “Shipment Tracking – Unified”
- “Environment”: Production (Default).
- This is the only environment we can provide for customers.
- “Rate Limit” :250 requests every 1 day (Default).
- If it doesn’t meet customer needs, customer can apply to upgrade Rate Limit after this APP creation.
- Click “+” button under “Add to app:” column, add it into “Selected APIs”
- Click” Create APP” to complete the creation.
- After creation, App Status is “in progress”.
- Click on the App name in below page, find Credential in App Information Page.
- When it is approved, an approval email will be sent to the registered email address. And the APP Status will be updated to” approved”.
Click the APP name as shown below to enter the details page.
- In below Tracking APP Detail page, click “Show Key” and then API key and API Secret can be shown.
2.3 Upgrade Rate Limit
- Click” Upgrade Rate Limit”, get into application page.
- Fill in the application form
“From which DHL division(s) do you want to track shipments?”: Choose all except” I don’t know”.
Fill in other fields as request, and then click” Send Message”.
- After submission, take notice that the notification email will be sent by <support@dpdhl.freshdesk.com> within 1-2 workdays.
3. Shipment Tracking API User Guide
Please use this link: https://developer.dhl.com/api-reference/shipment-tracking#get-started-section/ to check more details of Tracking API.
API Environment: https://api-eu.dhl.com/track
Description: Production