Pricing Templates
Log in Sign up
Integrations / DHL Express / ...

POST /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

Request headers

Name Type Required Description
Plugin-Version String No

Please provide version of the plugin (applicable to 3PV only)
Content-Type String Yes The media type of the request body.

Default value: "application/json"
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
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

Request body fields

Name Type Required Description
productsAndServices[] Array No

Please use if you wish to filter the response by product(s) and/or value added services
productsAndServices[].valueAddedServices[] Array No

Please use if you wish to filter the response by value added services
productsAndServices[].valueAddedServices[].serviceCode String Yes

Please enter DHL Express value added global service code. For detailed list of all available service codes for your prospect shipment please invoke /products or /rates
productsAndServices[].valueAddedServices[].method String No

For future use

Possible values:

  • "cash"
productsAndServices[].valueAddedServices[].localServiceCode String No

Please enter DHL Express value added local service code. For detailed list of all available service codes for your prospect shipment please invoke /products or /rates
productsAndServices[].valueAddedServices[].value Number No

Please enter monetary value of service (e.g. Insured Value)
productsAndServices[].valueAddedServices[].currency String No

Please enter currency code (e.g. Insured Value currency code)
productsAndServices[].localProductCode String No

Please enter DHL Express Local Product code
productsAndServices[].productCode String Yes

Please enter DHL Express Global Product code
monetaryAmount[] Array No

Please provide monetary amount related to your shipment, for example shipment declared value
monetaryAmount[].typeCode String Yes

Please provide the monetary amount type

Possible values:

  • "insuredValue"
  • "declaredValue"
monetaryAmount[].value Number Yes

Please provide the monetary value
monetaryAmount[].currency String Yes

Pleaseprovide monetary amount currency code
estimatedDeliveryDate Object No

Estimated delivery date option for QDDF or QDDC.
estimatedDeliveryDate.isRequested Boolean No

Please indicate if requesting to get EDD for this shipment. 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.

Default value: true
estimatedDeliveryDate.typeCode String No

Please indicate the EDD type being requested

Possible values:

  • "QDDF"
  • "QDDC"

Default value: "QDDF"
customerDetails Object Yes
customerDetails.shipperDetails Object Yes

Address defintion for rating related services
customerDetails.shipperDetails.addressLine3 String No

Please enter address line 3
customerDetails.shipperDetails.countyName String No

Please enter your suburb or county name
customerDetails.shipperDetails.postalCode String Yes

Please enter your postcode or leave empty if the address doesn't have a postcode
customerDetails.shipperDetails.cityName String Yes

Please enter the city
customerDetails.shipperDetails.provinceCode String No

Please enter your province or state code
customerDetails.shipperDetails.countryCode String Yes

Please enter ISO country code
customerDetails.shipperDetails.addressLine1 String No

Please enter address line 1
customerDetails.shipperDetails.addressLine2 String No

Please enter address line 3
customerDetails.receiverDetails Object Yes

Address defintion for rating related services
customerDetails.receiverDetails.addressLine3 String No

Please enter address line 3
customerDetails.receiverDetails.countyName String No

Please enter your suburb or county name
customerDetails.receiverDetails.postalCode String Yes

Please enter your postcode or leave empty if the address doesn't have a postcode
customerDetails.receiverDetails.cityName String Yes

Please enter the city
customerDetails.receiverDetails.provinceCode String No

Please enter your province or state code
customerDetails.receiverDetails.countryCode String Yes

Please enter ISO country code
customerDetails.receiverDetails.addressLine1 String No

Please enter address line 1
customerDetails.receiverDetails.addressLine2 String No

Please enter address line 3
productTypeCode String No

Please select which type of priducts you are interested in

Possible values:

  • "timeDefinite"
  • "dayDefinite"
  • "all"
packages[] Array Yes

Here you can define properties per package
packages[].dimensions Object Yes

Dimensions of the package
packages[].dimensions.height Number Yes

Height of the package
packages[].dimensions.length Number Yes

Length of the package
packages[].dimensions.width Number Yes

Width of the package
packages[].typeCode String No

Please contact your DHL Express representative if you wish to use a DHL specific package otherwise ignore this element.

Possible values:

  • "6BX"
  • "TBL"
  • "5BX"
  • "2BC"
  • "1CE"
  • "2BX"
  • "CE1"
  • "3BX"
  • "4BX"
  • "7BX"
  • "8BX"
  • "XPD"
  • "2BP"
  • "WB1"
  • "TBS"
  • "WB2"
  • "WB3"
  • "WB6"
packages[].weight Number Yes

The weight of the package.
localProductCode String No

Please enter DHL Express Local Product code
plannedShippingDateAndTime String Yes

Identifies the date and time the package is tendered. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone. The date component must be in the format: YYYY-MM-DD; the time component must be in the format: HH:MM:SS using a 24 hour clock. The date and time parts are separated by the letter T (e.g. 2006-06-26T17:00:00 GMT+01:00).
accounts[] Array No

Please enter all the DHL Express accounts and types to be used for this shipment
accounts[].typeCode String Yes

Please enter DHL Express acount type

Possible values:

  • "shipper"
  • "duties-taxes"
  • "payer"
accounts[].number String Yes

Please enter DHL Express account number
valueAddedServices[] Array No

Please use if you wish to filter the response by value added services
valueAddedServices[].serviceCode String Yes

Please enter DHL Express value added global service code. For detailed list of all available service codes for your prospect shipment please invoke /products or /rates
valueAddedServices[].method String No

For future use

Possible values:

  • "cash"
valueAddedServices[].localServiceCode String No

Please enter DHL Express value added local service code. For detailed list of all available service codes for your prospect shipment please invoke /products or /rates
valueAddedServices[].value Number No

Please enter monetary value of service (e.g. Insured Value)
valueAddedServices[].currency String No

Please enter currency code (e.g. Insured Value currency code)
getAdditionalInformation[] Array No

Provides additional information in the response like all value added services, and rule groups
getAdditionalInformation[].isRequested Boolean Yes
getAdditionalInformation[].typeCode String No

Provide type code of data that can be returned in response. Values can be allValueAddedServices, allValueAddedServicesAndRuleGroups

Possible values:

  • "allValueAddedServices"
  • "allValueAddedServicesAndRuleGroups"
requestAllValueAddedServices Boolean No

Legacy field and replaced by newer field getAdditionalInformation. Please set this to true to receive all value added services for each product available
payerCountryCode String No

payerCountryCode is to be provided if your profile has been enabled to view rates without an account number (this will provide DHL Express published rates for the payer country)
unitOfMeasurement String Yes

Please enter Unit of measurement - metric,imperial

Possible values:

  • "metric"
  • "imperial"
returnStandardProductsOnly Boolean No

Please set this to true to filter out all products which needs DHL Express special customer agreement
isCustomsDeclarable Boolean Yes

For customs purposes please advise if your shipment is dutiable (true) or non dutiable (false)
nextBusinessDay Boolean No

Please set this to true in case you want to receive products which are not available on planned shipping date but next available day

Default value: false
productCode String No

Please enter DHL Express Global Product code

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy