1. Overview
1.1 Brief
Provide push updates for the shipment statuses.
Advantage of Push Notifications:
- Avoid unnecessary API calls and data polling;
- Push updates provide close to real time status updates and continuously keeps consumers up-to-date. No need for actively requesting the latest shipment update in order to have the latest status.
Better customer experience:
Push updates are a flexible and simple solution, ready to be integrate into the customers workflow with minimal setup needed. The result being real time notifications, at a reduced cost.
Website: https://developer.dhl.com/user/login?destination=/api-reference/shipment tracking-unified-push#get-started-section/
If you want to know more details, please refer to the Overview page of the website.
Please note: Customers can only use the last-mile tracking number to request the Tracking Push API for tracking milestone push updates. Subscribing with a shipment ID will not trigger any tracking updates.To resolve this, customers can first call the Tracking Pull API using the shipment ID to retrieve the corresponding last-mile tracking number. Then, use that last-mile tracking number to request the Tracking Push API for subscription updates.
2. Registration Process
You must request credentials for using Tracking Push API.
➢ Create a developer account
o Type in the name, email, company name and other relevant information for registration
o CAPTCHA
o Click "Send" button
➢ DHL Employee – Click “Log in as a DHL employee”;
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?”
Figure 1 DHL API Developer Portal Log in Page
➢ Create a developer account
o Type in the name, email, company name and other relevant information for registration (It is recommended to register using the company email address, please DO NOT register using the NetEase 163 email address).
o CAPTCHA
o Click "Send" button
Figure 2 DHL API Developer Portal Register Page
➢ After registration, it will jump to the following page(Figure 3). Meanwhile, the registered mailbox will receive an email notification from DHL API Developer Portal. Please set the password according to the email.
Figure 3 DHL API Developer Portal
2.2 Get API Credential
1. To apply for API access: Please visit the Tacking Push API description page: https://developer.dhl.com/api-reference/shipment-tracking#get-started-section/, click the Get Access button in the upper right corner (Figure 4) and fill in the company information to apply for API access.
Figure 4 Tacking Push API Description Page
2. Fill in the access request: Please fill in the application information on the page in Figure 5. After completing the application information, please click Send message to send the application (Figure 6). After the application is successfully sent, you will receive a notification email to inform you that the API Customer Support Team has received your application.
Figure 5 Tacking Push API Access Request 1
Figure 6 Tacking Push API Access Request 2
3. Check the APP status: Click the icon in the upper right corner (Figure 7) to enter the User Dashboard page to view the APP (Figure 8). After creation, the APP status is "in progress". After the application is approved, the system will send an approval email to the registered email address, and the APP status will be updated to "approved".
Figure 7 User Dashboard Icon
Figure 8 APP Page
4. View API credentials: On the APP information page, click Shipment Tracking - Unified - Push (Figure 9). On the APP details page in Figure 10, click Show key to view the API Key and API Secret.
Figure 9 Click APP Name
Figure 10 APP Details
2.3 Upgrade Rate Limit
Click Upgrade Rate Limit (Figure 11) to enter the application page for upgrading the API rate limit (Figure 12). After filling in the form, click Send message to submit the application.
Figure 11 Upgrade Rate Limit
Figure 12 Upgrade Request
3. Shipment Tracking - Unified – Push API User Guide
Please visit the following Tracking Push API integration instructions page for detailed information.
API USER GUIDE:https://developer.dhl.com/api-reference/shipment-tracking-unified-push#get-started-section