DHL XML-PI Reference
CarrierID=7
Move to: Functions, Carrier Services, Special Services, Package Types, Label Configuration, Document Configuration, Billing Options
Go to: Carrier Components List
About
DHL XML-PI web service allows for website integration of DHL shipping functionality. DHL offers a wide range of international and domestic mail services.
Setup
Setup My System (onboarding wizard) is supported for this carrier, and it also has a dedicated Set up DHL XML-PI topic. However, the key detail for this carrier is:
- Requirements:
- DHL XML-PI Account Number
- Security Credentials Username and Password
- Setup stages (Administration App):
- Enable DHL XML-PI (Carriers page), and add Security Credentials (the Identifier field is your Security Credentials Username).
- Add the Account.
- Add Carrier Permissions.
- Configure International Defaults, and link to them from Carrier Permissions.
- Set up Outputs.
Functions
| Function | ID |
|---|---|
| Rate | 1 |
| Ship | 2 |
| Track | 3 |
| * Void | 4 |
* After voiding in an App, contact DHL to verify that they have voided the shipment.
Carrier Services
| Carrier Service | ID |
|---|---|
| Break Bulk Express (Documents Only Requires Carrier Approval) | 592 |
| Easyshop | 594 |
| Economy Select | 595 |
| Europack (Non-Documents Only) | 596 |
| Express 9:00 | 597 |
| Express 10:30 | 598 |
| Express 12:00 | 599 |
| Express Envelope (Documents Only) | 600 |
| Express Worldwide | 601 |
| Domestic Express 9:00 | 828 |
| Domestic Express 10:30 | 829 |
| Domestic Express 12:00 | 830 |
| Express Easy | 831 |
| Domestic Economy Select | 10112 |
| Jetline | 10113 |
| Sprintline | 10114 |
| Medical Express | 10115 |
| Freight Worldwide | 10116 |
| Jumbo Box | 10117 |
| Globalmail Business | 10118 |
| Same Day | 10119 |
Special Services
| Special Service | ID |
|---|---|
| Appointment Pickup | 2 |
| Holiday Delivery | 8 |
| Saturday Pickup | 17 |
| Holiday Pickup | 188 |
| Delivery Confirmation - No Signature | 38 |
| Insurance | 61 |
| Documents Only | 62 |
| Receiver Proactive Notification-Exception | 92 |
| Holiday Pickup | 188 |
| Remove Waybill for Paperless Trade | 390 |
| Paperless Trade | 416 |
Packages
| Package Type | ID |
|---|---|
| DHL Express Envelope | 20 |
| Other DHL Packaging | 21 |
| Customer Package | 22 |
| Jumbo Document | 598 |
| Jumbo Parcel | 599 |
| Document | 600 |
| Express Document | 601 |
| Freight | 602 |
| Jumbo Box | 603 |
| Jumbo Junior Document | 604 |
| Junior Jumbo Box | 605 |
| Jumbo Junior Parcel | 606 |
| Parcel | 607 |
| Your Packaging | 608 |
| Domestic | 909 |
| Express Document | 910 |
Label Configuration
| Output Type | ID | Generate From | Format | Printer | Stock |
|---|---|---|---|---|---|
| Label | 1 | Carrier | PDF EPL, ZPL |
Client*/Windows/Response Windows/Response |
Thermal 4x6 Thermal 4x8 |
*When Client printing, PDF will additionally need to be resized to fit the stock.
Document Configuration
| Output Type | ID | Generate From | Format | Printer |
|---|---|---|---|---|
| Commercial Invoice | 5 | Active Reports | Active Reports | Active Reports/Client/Response |
| *DHL Commercial Invoice | 5 | Carrier | PDF Raw | Response |
| Certificate of Origin | 6 | Active Reports | Active Reports | Active Reports/Client/Response |
| USMCA Certificate of Origin | 7 | Active Reports | Active Reports | Active Reports/Client/Response |
| SED | 8 | Active Reports | Active Reports | Active Reports/Client/Response |
This is specified using the 'Paperless Trade' special service. Processing a Paperless Trade international shipment returns a label and waybill document in the label response by default.
If just the label is desired without the waybill component, the 'Remove Waybill for Paperless Trade' special service can be selected as well.
Billing Options
| Billing | Duty Payer |
|---|---|
| Sender | Sender |
| Recipient | *Recipient |
*Ensure Duties Bill To Payer Type is set to Recipient when shipping non-dutiable products between European countries.
Related Content
- Carriers lists supported carriers and gives links to their reference topics.
