DHL EXPRESS - MyDHL API (Alpha)
v 3.0.0-alpha
Division: DHL Express

Best for:

  • Creating labels for time-definite international shipments
  • Users with a DHL Express customer account
  • Works for over 220 countries and territories worldwide
     
Region: Global
Used for: Shipping, Additional Services, Information
Overview

MyDHL API combines the benefits of DHL Express with your in-house shipping processes. Integrating into your website, it connects with your existing order entry,  warehouse management and other business software systems to help you run a more streamlined and efficient operation. Simply integrate!

MyDHL API is your one stop solution for all DHL EXPRESS service operations. It consists of:

 

Rating Icon

 

 

Parcel Icon

 

 

Fully Landed Cost

 

 

Shipment Icon

 

 

Pickup Icon

 

 

Tracking Icon

 

 

Globe Icon

 

 

Integrated Solutions

 

Rating Product Landed Cost Shipment Pickup Tracking Address Identifier

*Invitation Only: Please be advised that the DHL Express APIs (MyDHL API) are currently in Pilot with approved consumers and therefore data on this site shall not be distributed without consultation with the local DHL Express IT consultant first. After the Pilot the APIs will be made public

 

Optimize and grow your business
  • Integrate DHL Express functions – such as fulfilment processes – into your existing system seamlessly
  • Access shipping options and rates for DHL Express without the need to switch programs or re-enter information
  • Retain the user interface your teams are familiar with – no need for timely and costly employee training
  • Sell more at your e-commerce checkout by offering DHL Express shipping products, Landed costs and On Demand Delivery
Created for developers
  • A single API based on industry standards that developers know and understand
  • Built with the fast-paced warehouse and time-sensitive e-commerce checkout in mind
  • Dedicated API environment to test your solution
  • Developer support from local DHL Express API experts

 

Scope

Do more with MyDHL API
MyDHL API Services Description
RATING
The Rating service Operation will return DHL EXPRESS product capabilities (products, value added services and estimated delivery time) and your DHL EXPRESS Account rates. 
PRODUCT
A light-weight version of the Rating service to retrieve available DHL Express products for a one-piece shipment.
LANDED COST
Retrieve the estimated Landed Cost which includes Duties & Taxes. Please note for this service a catalogue of your items together with the customs data (i.e. HS Codes) needs to be provided upfront. 
SHIPMENT

The Shipment service Operation allows you to create complete DHL EXPRESS shipments which includes the shipping labels, optional customs documentation and pickups together with value added services such as Insurance. 

DHL EXPRESS recommends to use the Rating service first to see all the available products and value added services first to then pass the desired DHL EXPRESS product and value added service into the Shipment service Operation.

In addition to creating DHL Express shipments the SHIPMENT service can also provide electronic proof of delivery for certain delivered shipments and upload updated customs invoice images for your shipments.

PICKUP
The Pickup service can create, update or cancel DHL Express pickup requests 
TRACKING
The Tracking service retrieves tracking statuses for DHL Express Shipments
ADDRESS
Validates if DHL Express has got pickup/delivery capabilities at origin/destination
IDENTIFIER
Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments

 

Using the API

The API has been designed for use by developers. You will need basic knowledge of REST APIs, JSON, and HTTPS. Also, your organization must to have an active customer account with DHL Express. If you need to learn more on how to get an account, go to the DHL Express customer account request page

 

Example use cases

SIMPLY INTEGRATE IN YOUR EXISTING WEBSITE / SOLUTION

Incorporating DHL shipping functionality into your websites, customer service applications or order processing systems makes it easy for you to ship and your customers to receive their parcels. DHL Express API allows you to stay up to date with DHL service availability, transit times, rates, shipment and courier pickup booking, along with shipment tracking from countries around the world. 

User Guide

*Invitation Only: Please be advised that the DHL Express APIs (MyDHL API) are currently in Pilot with approved consumers and therefore data on this site shall not be distributed without consultation with the local DHL Express IT consultant first. After the Pilot the APIs will be made public

 

Get Access

To use the DHL Express API, your organization requires to have an active customer account with DHL Express.

I already have a DHL Express Account number:

[1.] Start my integration development
[2.] Request Review
[3.] API access
 
Click here to request access credentials to MyDHL API

A DHL Express IT representative in the country of your registration will review your request and will either approve credentials to the MyDHL API Test environment or contact you for further information if needed

Once approved, your access details will be available at the My Apps dashboard. 

If you are not a DHL Express customer, please proceed with the steps below to create a new customer account:

[1.] Request a customer account.
[2.] Account Setup
[3.] Get API access
Go to the DHL Express customer account request page
Complete the form and click Submit. 

The DHL Express team will contact you to set up your account. 

Once you have been given your DHL Express Account, you will be provided with access to the DHL Express API/MyDHL API

    Authentication

    Your DHL EXPRESS consultant will provide you with access credentials to the DHL EXPRESS API (MyDHL API) and assist in technical queries you may have.

     

    Environments

    The addressable API base URL/URI environment is:  

    Environment Description
    https://express.api.dhl.com/mydhlapi/test  Test environment to test your development against
    https://express.api.dhl.com/mydhlapi Production environment to create real transactions with DHL Express

     

    Quota Limits

    • The DHL EXPRESS Test Environment will provide you a daily limit of 500 Service invocations for your access credentials. This should be used to test your integration development with DHL EXPRESS
    • The DHL EXPRESS Test Environment has formal SLA's against it to ensure that support is at hand with availability. 

     

    Additional Information

    The input data for DHL Express API is validated in several steps. The first step is general schema validation
    based on data cardinality and data content restrictions defined by the request message format (i.e.
    schema validation). In a second step, several business rules are applied on the passed data. The
    results of these validations are placed in the result message of the service operation. The service
    operation always delivers a result message. All errors or validation errors are stored in this result
    messages. 

    Legal Terms
    specifics for the use of dhl Express API
    • To register for the use of DHL EXPRESS API You and/or the entity you are authorized to represent (hereinafter “You”/”Your”) need to have an account with a DHL Express entity, i.e. API Productive Key and access will be provided to You under the prerequisite of a successful validation of Your credentials (esp. DHL Express account number).

      These Legal Terms do not replace and/or modify the DHL Express Terms and Conditions of Carriage, any DHL Express transportation services agreement or Agreements, which govern Your DHL Express shipments.

      You shall use the services and/or data that You receive via the DHL EXPRESS API only for the legitimate contractual purposes and only in connection with Your DHL Express shipments.

      The following prerequisites and/or restrictions apply for the usage of data or information received via the DHL EXPRESS API:

    • Rating:
      • Data requested and received, such as product name, rate, lead time/estimated delivery date, is hereinafter referred to as “Rating Data”.
      • The Rating Data, i.e. esp. the information about rates and transit time and/or delivery date, is only indicative and not guaranteed. DHL Express has no liability or responsibility for differences between this indicative quote and the actual rate or transit time.
      • The final rate and/or transit time may differ based on the characteristics of the shipment, services requested and the packages actually tendered to DHL Express.
      • Rates quoted may not include duties, taxes, customs charges or all surcharges and fees.
      • You shall not reveal to and/or provide any third parties, esp. other transportation and/or logistics services providers, with the Rating Data without our prior written consent.
      • You shall not store and/or modify Rating Data in any form; it is especially prohibited to analyze and/or derive data/information for competitive purposes from the Rating Data without our prior written consent.
      • You shall only publish, display and/or otherwise use Rating Data in connection with rating data of other logistics/transportation services providers (e.g. show DHL Express´ rates together with rates of other transportation and/or logistics services providers on a website or comparison portal– or any other (electronic) channel and/or medium), provided that You
        • always show and/or display all relevant Rating Data, that has been provided to You via the DHL EXPRESS API (i.e. esp. without dismissing single rates, which are favorable for the specific customers), and
        • don´t specifically select, prioritize and/or recommend single rates  thus contradicting DHL Express’ business interests, and
        • comply with applicable laws especially in the field of anti-trust and competition law.
    • Shipment / Labeling:
      • In case You use the service “printing of labels”, please note that the printing of the label does not constitute the contract of carriage/shipment. Such contract will be concluded when the labeled shipment is handed over or picked up and accepted by DHL Express.
    • Tracking:
      • You may only submit tracking event data to the recipient of the DHL Express shipment and no other person; such submission shall always be in compliance with applicable laws in the field of data protection and competition law, which includes that the data shall not be combined with advertisement or presented in a way that it could be regarded as advertisement.
      • If You are neither the sender nor the recipient of DHL Express-shipment/s, the tracking event data refers to,
        • You shall ensure, that you are authorized to act on behalf of the sender;
        • You shall make the sender aware of the restrictions set out in this User Guide just as the General Developer Portal Terms of Use;
        • You shall make the sender aware of the necessity to inform the recipient transparently about the processing of his/her personal data according to applicable data protection laws.
      • In no case shall you reveal and/or provide third parties with the Waybill Number/Shipment ID and/or tracking event data and/or analyze, modify such data in any form and/or derive data/information especially for competitive reasons from it without our prior written consent.
      • You shall delete the Waybill Number/Shipment ID and tracking event data 30 days after the delivery (of the shipment) to the recipient is completed.
    • Proof of Delivery:
      • You shall not tamper with or otherwise misuse the electronic signature that You receive in the context of the electronic proof of delivery document. Such document is for Your own accounting and/or evidentiary purposes only.
    3.0.0
    11.Jun.2025
    • Landed Cost
      • Supported new 'preferential_rate' type in 'estimatedTariffRateType '
      • 'default_rate' as standard estimated tariff type
    • Shipment
      • Package type code auto populate dimensions and dimension field is optional field
      • Return all error messages from backends
      • Loosen both Gross and Net weight to be mandatory at line item level
    • Invoice
      • Loosen both Gross and Net weight to be mandatory at line item level
    • Add Piece (new)
      • Support to add new pieces to a previously created shipment
    • Early Shipment Screening
      • Support early shipment screening for break bulk baby shipments
    2.1.0
    11.Jul.2021
    • Shipment

      • Support for upload Invoice data for existing shipment
      • Support for additional customs related e-commerce rules
    • Invoice – new API

      • Support for upload Invoice data before shipment is created
    2.0.0
    11.Mar.2021
    • Shipment
      • Support for the new European Union VAT and customs e-commerce rules for the import of low value consignments as of July 1st 2021
      • Support for Loose BBX shipments
      • Support for Label-Less return shipments
      • Support for Cash-On-Delivery shipments
      • Support for upload of additional document images for Advanced Shipments
         
    1.1.0
    20.Jul.2020

    Added new endpoints to the API:

    • Tracking
    • Pickup
    • Identifier
    • Address
    1.0.0
    27.Mar.2020
    • Initial Release of Rates, Shipments & Fully Landed Cost - ready for Pilot