GET /rates
The Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
Servers
- https://api-mock.dhl.com/mydhlapi
- https://express.api.dhl.com/mydhlapi/test
- https://express.api.dhl.com/mydhlapi
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Plugin-Version |
String | No |
Please provide version of the plugin (applicable to 3PV only) |
Shipping-System-Platform-Version |
String | No |
Please provide version of the shipping platform (applicable to 3PV only) |
Webstore-Platform-Version |
String | No |
Please provide version of the webstore platform (applicable to 3PV only) |
Message-Reference-Date |
String | No |
Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2 |
Webstore-Platform-Name |
String | No |
Please provide name of the webstore platform (applicable to 3PV only) |
Shipping-System-Platform-Name |
String | No |
Please provide name of the shipping platform(applicable to 3PV only) |
Message-Reference |
String | No |
Please provide message reference |
Plugin-Name |
String | No |
Please provide name of the plugin (applicable to 3PV only) |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
requestEstimatedDeliveryDate |
Boolean | No |
Option to return Estimated Delivery Date in response Default value: true |
originPostalCode |
String | No |
Text specifying the postal code for an address. https://gs1.org/voc/postalCode |
destinationCityName |
String | Yes |
Text specifying the city name |
height |
Number | Yes |
Total height of the shipment including packaging. |
width |
Number | Yes |
Total width of the shipment including packaging. |
plannedShippingDate |
String | Yes |
Timestamp represents the date you plan to ship your prospected shipment |
destinationPostalCode |
String | No |
Text specifying the postal code for an address. https://gs1.org/voc/postalCode |
estimatedDeliveryDateType |
String | No |
Estimated Delivery Date Type. QDDF: is the fastest transit time as quoted to the customer at booking or shipment creation. When clearance or any other non-transport operational component is expected to impact transit time, QDDF does not constitute DHL's service commitment. QDDC: cconstitutes DHL's service commitment as quoted at booking or shipment creation. QDDC builds in clearance time, and potentially other special operational non-transport component(s), when relevant. Possible values:
Default value: "QDDF" |
accountNumber |
String | Yes |
DHL Express customer account number |
getAllValueAddedServices |
Boolean | No |
Option to return list of all value added services and its rule groups if applicable Default value: false |
length |
Number | Yes |
Total length of the shipment including packaging. |
strictValidation |
Boolean | No |
If set to true, indicate strict DCT validation of address details, and validation of product and service(s) combination provided in request. Default value: false |
destinationCountryCode |
String | Yes |
A short text string code (see values defined in ISO 3166) specifying the shipment destination country. https://gs1.org/voc/Country, Alpha-2 Code |
unitOfMeasurement |
String | Yes |
The UnitOfMeasurement node conveys the unit of measurements used in the operation. This single value corresponds to the units of weight and measurement which are used throughout the message processing. Possible values:
|
originCityName |
String | Yes |
Text specifying the city name |
isCustomsDeclarable |
Boolean | Yes |
Possible values:
|
originCountryCode |
String | Yes |
A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code |
weight |
Number | Yes |
Gross weight of the shipment including packaging. |
nextBusinessDay |
Boolean | No |
When set to true and there are no products available for given plannedShippingDate then products available for the next possible pickup date are returned Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.