DHL eCommerce API Reference

CarrierID=128

Move to: Functions, Carrier Services, Special Services, Package Types, Documents, Labels

Go to: Carrier Components List

About

DHL eCommerce API offers a selection of expedited mail options to send domestically or internationally using a single source. For more details, visit the DHL eCommerce website. Alternatively, see the service guide.

Setup

Setup My System is supported for this carrier. If onboarding manually, alongside the general guidance given in Set up a carrier, the key detail for this carrier is:

  • Requirements:
    • DHL eCommerce API Account Number
    • Security Credentials Username and Password
    • Shipping Key (Pickup Account number)
    • DHL eCommerce Distribution code
  • Setup stages (Administration App):
    • Enable DHL eCommerce API (Carriers page), and add Security Credentials (the Identifier field is your Security Credentials Username).
    • Add the Account, including the Shipping Key (Pickup Account number) and DHL eCommerce Distribution code.
    • Add a Package Tracking Number Range (Data page), and associate it with a DHL eCommerce API Account (Accounts page).
    • Add Carrier Permissions.
    • Set up International Defaults.
    • Set up Outputs.

Top

Functions

Function ID
Rate 1
Ship 2
Track 3
Void 4
EOD 124

Top

Carrier Services

Carrier Service ID
DHL SmartMail Parcel Ground 10074
DHL SmartMail Parcel Expedited 10075
DHL SmartMail Parcel Expedited Max 10076
DHL Parcel International Direct Priority 10077
DHL Parcel International Direct Standard 10078
DHL SmartMail Bound Printed Matter Expedited 10080
DHL SmartMail Bound Printed Matter Ground 10081
DHL SmartMail Marketing Parcel Expedited 10082*
DHL SmartMail Marketing Parcel Ground 10083*
DHL Parcel International Direct 10088
DHL Parcel International Standard 10089
DHL Packet Plus International 10090*
DHL Packet International 10091
DHL Globalmail Packet - IPA 10093*

*These services are disabled by default inTranstream but supported for legacy users.

Note. SmartMail Services are US domestic only. GlobalMail and Parcel Services can be sent to and from any supported country.

Top

Special Services

Special Service ID
** Delivery Confirmation - No Signature 38
** Delivery Confirmation - Signature Required 39
† Service Endorsement - Address Service Requested 69
† Service Endorsement - Change Service Requested 71
† Service Endorsement - Forwarding Service Requested 72
† Service Endorsement - Return Service Requested 73
† Lithium Battery 418
† Lithium Battery Material - Lithium Ion 419
† Lithium Battery Material - Lithium Metal 420
† Lithium Battery Packing - Contained In Equipment 421
† Lithium Battery Packing - Packed With Equipment 422
† Lithium Battery Packing - Stand Alone 423

* Only supported with Domestic services.

** Only supported with Metro, SmartMail and Globalmail services.

† Only supported with SmartMail and Globalmail services.

Top

Package Types

Package Type ID
Customer Packaging 862

Top

Documents

Output Type ID Generate From Format Printer Stock
DHL Domestic Manifest 259 Carrier PDF Raw Windows/
Client 		Letter 8.5x11
DHL International Manifest 260 Carrier PDF Raw Windows/
Client 		Letter 8.5x11

Top

Labels

Output Type ID Generate From Format Printer Stock
Label 1 Carrier Image/ ZPL Windows/Client Thermal 4x6

Top

  • Carriers lists supported carriers and gives links to their reference topics.
Article last edited 6 April 2021