OVERVIEW
OVERVIEW
AUTHENTICATION
AUTHENTICATION
ENDPOINTS
Shipping Label
Shipping Label Edit
Shipment Delete/Cancel
Shipment Creation
Close-Out
Manifest
Domestic Manifest
Reprint Shipping Label
Pickup
Pickup Label
Tracking
ENDPOINTS
Shipping Label
Shipping Label
Close-Out
Close-Out
Manifest
Manifest
Tracking
Tracking
APPENDIX
APPENDIX
English
Thai
Chinese
API OVERVIEW
Resources are accessible via https and are located at api.dhlecommerce.dhl.com. For example, you can get an access token by accessing the URL with the client id and password (replace :clientid and :password with your own):
Example
https://api.dhlecommerce.dhl.com/rest/v1/OAuth/AccessToken?clientId=CLIENT123=&password=PASS123&returnFormat=json
API Connectivity Test
We recommend conducting the below PING tests from the API requestor server to DHLeC test and production environments to identify any network or firewall issues from origin.
- PING api.dhlecommerce.dhl.com
If any abnormality is noticed, it is recommended to conduct further traceroute tests and provide results to your network team supporting the API requests.
REQUEST METHOD
The URLs are in RESTful and every resource (URL) currently supports one of the two different HTTPS verbs:
- GET Requests fetch information about an object
- POST Requests create objects
REQUEST STRUCTURE
The Envelope
Every request (except Authentication and Tracking) contains a header and body with data that is critical to retrieve a successful response.
RESPONSE STRUCTURE
The Envelope
Every response contains a similar header and body structure. If the request is successful, a code key with value 200 is always returned. If the request is unsuccessful, a response similar to the below will be returned.
Sample Request
loading...
Sample Response
loading...