This API provides an interface for shippers' organizations to manage and submit their shipments with functionalities such as tracking, rating & routing, containerization, manifesting, and voiding.

Services

Public services

Shipping 

The DHL Ship Manager enables certain operations on the shipments, such as creation, submission to multiple carriers in a different manner, voiding, containerization, and obtaining documents for created shipments, such as labels. On the submission, it is also integrated with the carriers' submission process.

Carrier Account code placeholder

Manifesting

Besides Shipping functionalities, DHL Ship Manager enables manifesting capabilities, by the meaning of manifest creation for previously created shipments, and obtaining the manifesting documents. It is also integrated with the carriers' manifesting processes.

Supported Carriers/Product List

• DHL eCommerce Europe

• DHL eCommerce Americas

• DHL Express

• eCS UK

• eCS PL

• Deutsche Post International

Get Access

DHL Ship Manager can be accessed through an API client. The assumption for the upcoming Authentication steps is that a user is already successfully onboarded.

Authentication

For authentication purposes, you must obtain an OAuth token and pass the same via the request "Authorization" header. To retrieve this token you have to perform the following steps below. You need to replace the variable placeholders indicated with "<>" with your personalized credentials from the Developer Portal.

To view your API subscription keys:

1. From the My Apps screen, click on the name of your app.
   The Details screen appears. 
2. If you have access to more than one API, click the name of the relevant API. 
   Note: The APIs are listed under the “Credentials” section. 
3. Click the Show link below the asterisks hiding the Consumer Key and Secret. 
   The Consumer Key & Secret appears.    

1. Generate your base64 key

• The credentials <your-consumer-key>:<your-consumer-secret> have to be base64 encoded to generate access token. 
• Type the below command in your terminal:

  $ echo -ne <your-consumer-key>:<your-consumer-secret> | base64

• Example output:

  eW91cl91c2VybmFtZV9nb2VzX2hlcmU6eW91cl9wYXNzd29yZF9nb2VzX2hlcmU=

• This is <your-base64-encoded-key>

  Basic eW91cl91c2VybmFtZV9nb2VzX2hlcmU6eW91cl9wYXNzd29yZF9nb2VzX2hlcmU=

The given output will be used to authorize you to generate the access token.

2. Generate your access token

• The approach to generate an access token using the base64 key is shown here using curl as an example, please modify it based on the tool you are using
• Type the below command in your terminal:

  curl --location --request POST 'https://api-uat.dhl.com/auth/v1/token?response_type=access_token&grant_type=client_credentials' \
  
  --header 'Authorization: Basic eW91cl91c2VybmFtZV9nb2VzX2hlcmU6eW91cl9wYXNzd29yZF9nb2VzX2hlcmU='

• The response received should be similar to the below:

  {
      "access_token": "1ilKYL7sO9IFrQpBeGYHAoT9lvJZ",
      "token_type": "Bearer",
      "expires_in": 1799
  }

The given access token can now be applied to the request "Authorization" header to call the DHL Ship Manager API. This is an example of the call:

curl --location --request POST 'https://api-uat.dhl.com/csi/shipping/dsm/public/v1/container' \
--header 'Content-Type: application/json' \
--header 'Accept: application/hal+json' \
--header 'Authorization: Bearer 1ilKYL7sO9IFrQpBeGYHAoT9lvJZ' \
--data-raw '{
  "code": "container_code",
  "name": "Container1",
  "barcode": "bc",
  "sortcode": "sc"
}'

Environments

The addressable API base URL/URI environments are:  

Rate limits

Maximum of 50 calls per second. Rate limit is 3000pm

1. The DSM API is provided to you by Deutsche Post DHL Research & Innovation GmbH (hereinafter referred to as “DHL”).
2. When using or accessing the DSM API and its associated services (the “DP DHL Services”; for the avoidance of doubt, a reference to DSM API in these Legal Terms is deemed a reference to the DSM API including the DP DHL Services, unless the context suggests otherwise) you are entering into a binding legal agreement consisting of DP DHL’s General Developer Portal Terms of Use and these Legal Terms including any regulations in referenced documents (e.g. in the Services Specifics).
3. To register for the use of DSM API You and/or the legal entity you are authorized to represent (hereinafter “You”/”Your”) need to maintain an active customer account including a customer number or customer ID with a company of Deutsche Post DHL Group. An API Productive Key and access details will be provided to You subject to a successful validation of Your credentials.
4. If You engage an external developer or other IT services provider to develop Your Application or any other third party (“Third Parties”) to access and/or use the DSM API on Your behalf, You remain fully liable for any acts or omissions of such Third Parties in connection with the access to and/or usage of the DSM API.
5. The Legal Terms govern Your use of and/or access to the DSM API and, unless otherwise stated herein, do not replace and/or modify the applicable terms and conditions of carriage; any transportation services agreement; or any other agreements with a company of Deutsche Post DHL Group, which govern services or products provided to You (separately, each an “Agreement”). Notwithstanding the foregoing, You expressly acknowledge and agree that solely with respect to Your use of and access to the DSM API the Legal Terms shall take precedence over the terms and conditions in an Agreement, unless an Agreement specifically addresses the use of or access to the DSM API by You, in which case the Agreement shall prevail.
6. You grant DHL the right to use all data, documents, logos or other information transmitted by You to or within the DSM API (“Information”), for the purposes specified in the Services Specifics and/or the API Services section below. This includes the use of the Information for the purpose of processing and transporting shipments. You shall ensure that all Information which You transmit to DHL via the DSM API is complete, correct and accurate. You will be solely responsible for any damage or consequence that may arise from the use of false or incorrect or incomplete Information.
7. You are responsible for all activities conducted via the DSM API in accordance with all applicable laws, in particular competition and data protection laws. You shall be responsible for the provision of the correct legal ground to process personal data..
8. DHL will handle personal data in accordance  with a separately concluded Controller-to-Processor Agreement.
9. You shall use the DSM API only for the legitimate contractual purposes and only in connection with Your DP DHL shipments.
10. You agree and acknowledge, that by using the DSM API you can create and print shipping labels (including being provided with a DHL shipment ID). The creation of a label within DSM API does usually not constitute the contract of carriage. The contract of carriage will in general be concluded when the shipment is handed over or picked up and accepted by the relevant carrier within Deutsche Post DHL Group (specifics are regulated in the underlying transportation contract or terms of carriage).
11. For some shipment products, you can delete or cancel shipments, unless a shipment has already been accepted or picked up the by the relevant carrier within Deutsche Post DHL Group (specifics – especially regarding potential cancellation charges – are regulated in the underlying transportation contract or terms of carriage).

Rate limits

Maximum of 50 calls per second. Rate limit is 3000pm