API Technical Overview

DHL eCommerce provides Global API to enable open integration channel for clients. API is provided as a REST API using OAuth 2.0 for authentication and authorization and JSON format for request and response messages. The API uses HTTP (over SSL) protocol, the HTTP GET is used to retrieve data and HTTP POST is used to create, update or delete data. Usage of HTTP PUT and DELETE is not allowed.


API Environments

DHL eCommerce provides Production environment as well as Sandbox for development and testing. Both environments have managed access and you have to request authentication credentials via Contact page. You will have different identities for Production and Sandbox environment.


Sandbox

For development and testing purpose you can use the Sandbox environment. Sandbox hosts same APIs as Production evironment, but with different base URL. For developers there is a Swagger-based documentation available.

Sandbox Base URL: https://api-qa.dhlecommerce.com/

Sandbox


Production

For production purpose you have to use Production environment. Sandbox hosts same APIs as Production evironment, but with different base URL.

Production Base URL: https://api.dhlecommerce.com/

Production


Rate limits

For all API calls there is a rate limit 5 requests per second. When the limit is reached you will recieve an HTTP Status code 429: Too many requests.


      HTTP Response Status Code 429
      {
        "reasons": [{"msg" : "Too many requests in a given amount of time"}],
        "details": {
          "msgId": "Id-135725589d........."
        }
      }