DHL Express stands as a global courier and logistics company that offers international shipping and express delivery services renowned for their swift and dependable options. These encompass express airfreight, international parcel delivery, and an array of logistics solutions.
To initiate the registration process for a DHL Express carrier account, users must possess the following pre-requisites:
- An Account Number
- Security Credentials in the form of a Username and Password
To complete the onboarding of a DHL Express carrier account, an API request call is executed, encompassing all the essential details. Presented below is an example of such a request.
{
"accountNumber": "XXXXXXX",
"carrierID": "DHLEXP",
"description": "DHLEXP by API",
"carrierAccountType": "Shipping",
"provisioningType": "API",
"parameters": {
"username": "XXXXXXXX",
"password": "XXXXXXXX"
}
}Upon successful the request to establish the DHL Express carrier account, the ensuing response will resemble the provided Sample Response below.
{
"carrierAccountID": "BGkmpD7Lll7",
"description": "DHLEXP by API",
"carrierID": "DHLEXP",
"accountNumber": "XXXXXXX",
"parameters": {
"username": "XXXXXXXX"
},
"carrierAccountType": "Shipping",
"provisioningType": "API"
}The APIs integrate with DHL Express through the following operations:
| Operations | Method | Resource Path |
|---|---|---|
| Add a Carrier Account | POST | /api/v1/carrierAccounts |
| Rate a Parcel | POST | /api/v1/rates |
| Create a Shipping Label | POST | /api/v1/shipments |
| Reprint a Label | GET | /api/v1/shipments/{{shipmentId}}/reprint |
| Void a Label | PUT | /api/v1/shipments/{{shipmentId}}/cancel |
| Get Tracking Information | GET | /api/v1/tracking/{{trackingNumber}} |
Metadata provides information about DHL carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.