MyDHL is a web service from DHL, one of the major logistics providers globally.
In this article, you will learn how to connect MyDHL to ShippyPro and add additional options such as a return label in the box or paperless trade to your existing connection. ✨
1. Before you start
Register at DHL.com
To proceed with the connection, you need to have a Username (which is the API Key, not an email address), a Password (which is the API Secret), and an Account Number that you can retrieve by registering to DHL.com if you don't have one yet.
How to fill out the form
At "How would you like to use the API?" inside the DHL registration page, you should select the option "I require credentials to DHL Express – MyDHL API for an existing plugin/ecommerce platform/third-party solution" and simply add ShippyPro.
Concerning the section called "Requested Services", please tick over all the services available. The field named "Transaction volume per month" is only useful to DHL for statistics purposes, therefore it won't influence you on the use of the API.
After about 3 to 4 hours you can check your DHL Developer profile where you should be able to see your App Status as approved.
Then, click on DHL EXPRESS – MYDHL API under App Name where you will Request Production Access on a red button. Once you click it, you'll receive confirmation after a few minutes.
2. Connect MyDHL to ShippyPro
Now that everything is correctly set up in MyDHL portal, you're ready to connect it to ShippyPro.
Navigate to Carriers > Connection and click on MyDHL Logo (simply type "MyDHL" on the search bar to spot it in a sec).
Enter your API key as Username and your API Secret as Password
Pick your label type and your product code. Remember to ask your DHL Account Manager which are your active product codes. If you'd like to add multiple services, you'll need to create a new connection for each one.
ECONOMY SELECT NONDOC (ESI)
EXPRESS 9:00 DOC (TDK)
EXPRESS 9:00 NONDOC (TDE)
EXPRESS 10:30 DOC (TDL)
EXPRESS 10:30 NONDOC (TDM)
EXPRESS 12:00 DOC (TDT)
EXPRESS 12:00 NONDOC (TDY)
EXPRESS DOMESTIC (DOM)
EXPRESS DOMESTIC 9:00 (DOK)
EXPRESS DOMESTIC 10:30 (DOL)
EXPRESS DOMESTIC 12:00 (DOT)
ECONOMY SELECT DOMESTIC (DES)
EXPRESS WORLDWIDE DOC (DOX)
EXPRESS WORLDWIDE NONDOC (WPX)
EXPRESS WORLDWIDE EU (ECX)
FREIGHT WORLDWIDE (FRT)
ECONOMY SELECT EU (ESU)
EXPRESS ENVELOPE DOC (XPD)
MEDICAL EXPRESS DOC (CMX)
MEDICAL EXPRESS NONDOC (WMX)
EXPRESS JUMBO (WPX)
SAME DAY (SDX)
3. Additional Options
🔁 Print return labels
You can print your return labels with the shipping label by ticking Print Return Label and inserting your DHL Return Account Number. Please note that the label format will be the one you chose for outbound shipments since it cannot be changed for return labels.
If you’d like to print shipping and return labels together while you ship your orders (return label in the box), add your DHL Return Account Number inside the DHL Account Number field and your Account Number in the DHL Return Account Number field. Then tick "Print Return label option" at the bottom and confirm.
If you’d like to make Returns separately from the main shipment, you need to create a new myDHL connection. This time, insert your Return Account Number in the Account Number field and your Account Number in the DHL Return Account Number field. So basically, the exact opposite of the first set-up. Then, you can create your manual shipment for the Return: click here to learn how.
🌱 Paperless Trade
You can also decide to enable the Paperless documentation option by ticking "Paperless Trade"
🧾 Print commercial invoice
This option will automatically print your commercial invoices for international shipments. There are two options to transmit invoices to myDHL:
Paperless Trade enabled: you won't upload invoices via ETD
Paperless Trade disabled: you need to send invoices via ETD
By selecting this option, you won't have to enable the check box in modal if you are going to use ETD.
🗓 Data Staging Environment
By selecting the Data Staging Environment option, you can extend the duration of a label without knowing the actual date of handling to the Carrier.
🧪 Test Mode
Enable the Test Mode if you'd like to make some test shipments. Please keep in mind that this option should be flagged only if you have test credentials, not production credentials!
✍🏻 Custom Label
If you want, you can also enter a Custom Label to recognize the connection among all the others.
4. Errors & troubleshooting
While trying to connect MyDHL or while using it to ship your orders, you might experience some errors. No panic: keep reading to discover how to fix them! 🧑🔧
7008: The requested Special Service Code: #/valueAddedServices/0/serviceCode ‘WY’ is not available between this origin and destination. Please validate the products and services combination (via the /rates or /products service) or contact our customer service.
This error appears whenever you enable the paperless option for a non-dutiable shipment (for example a national or inside EU shipment).
Error Da rielaborare: #/customerReferences/0: required key [value] not found, #/outputImageProperties/customerBarcodes/0: required key [content] not found
In this case, please make sure to have correctly added the order ID as it's considered as mandatory info for the Carrier.
Da rielaborare: 1001: The requested product(s) (P) not available based on your search criteria.(409224511)
The indicated destination city is invalid: eg. "cityName": "NA". You can check the postcodes and locations accepted by myDHL system at this link: https://dct.dhl.com/
410138: Requested product(s) not available at payer, H/-
The Product Code (meaning the DHL service) is wrong. Please check it with your DHL representative and select the correct one.
In this case, always check if you input the correct credentials, and pay extra attention if you added an extra space in the username. You can check the settings from Carriers > Connection and, once the Carrier is selected, click on Edit.
Value is shorter than minimum length
Either sender's VAT number or recipient's IOSS number is missing from your profile