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

POST /landed-cost

The Landed Cost section allows further information around products being sold to be provided. In return the duty, tax and shipping charges are calculated in real time and provides transparency about any extra costs the buyer may have to pay before they reach them.

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)

Request body fields

Name Type Required Description
customerDetails Object Yes

Here you need to define all the parties needed to ship the package
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
transportationMode String No

Possible values:

  • "air"
  • "ocean"
  • "ground"
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
accounts[] Array Yes

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
shipmentPurpose String No

Possible values:
commercial: B2B
personal: B2C
commercia': B2B
personal: B2C

Possible values:

  • "commercial"
  • "personal"
merchantSelectedCarrierName String No

Carrier being used to ship with. Allowed values are:
'DHL','UPS','FEDEX','TNT','POST',
'OTHERS'

Possible values:

  • "POST"
  • "DHL"
  • "UPS"
  • "TNT"
  • "FEDEX"
  • "OTHERS"
items[] Array Yes
items[].description String No

Item full description
items[].unitPriceCurrencyCode String Yes

Currency code of the Unit Price
items[].number Number Yes

Line item number
items[].brand String No

Item's brand
items[].quantity Number Yes

Total quantity of the item(s) to be shipped.
items[].customsValueCurrencyCode String No

not used
items[].estimatedTariffRateType String No

Please enter Tariff Rate Type - default_rate,derived_rate,highest_rate,center_rate,lowest_rate

Possible values:

  • "highest_rate"
  • "default_rate"
  • "lowest_rate"
  • "center_rate"
  • "derived_rate"
items[].customsValue Number No

not used
items[].commodityCode String No

commodityCode is mandatory if estimatedTariffRateType ('derived_rate' or 'highest_rate' or 'lowest_rate' or 'center_rate') not provided in the request otherwise it is considered as Optional.
'highest_rate' or 'lowest_rate' or 'center_rate') not provided in the request otherwise it is considered as Optional.
Can be provided with or without dots
items[].manufacturerCountry String No

ISO Country code of the goods manufacturer
items[].category String No

commodityCode category can be retrieved via referenceData API/ commodityCategory dataset.
Category code of the Item.
101 - Coats & Jacket
102 - Blazers
103 - Suits
104 - Ensembles
105 - Trousers
106 - Shirts & Blouses
107 - Dresses
108 - Skirts
109 - Jerseys, Sweatshirts & Pullovers
110 - Sports & Swimwear
111 - Night & Underwear
112 - T-Shirts
113 - Tights & Leggings
114 - Socks
115 - Baby Clothes
116 - Clothing Accessories
201 - Sneakers
202 - Athletic Footwear
203 - Leather Footwear
204 - Textile & Other Footwear
301 - Spectacle Lenses
302 - Sunglasses
303 - Eyewear Frames
304 - Contact Lenses
401 - Watches
402 - Jewelry
403 - Suitcases & Briefcases
404 - Handbags
405 - Wallets & Little Cases
406 - Bags & Containers
501 - Beer
502 - Spirits
503 - Wine
504 - Cider, Perry & Rice Wine
601 - Bottled Water
602 - Soft Drinks
603 - Juices
604 - Coffee
605 - Tea
606 - Cocoa
701 - Dairy Products & Eggs
702 - Meat
703 - Fish & Seafood
704 - Fruits & Nuts
705 - Vegetables
706 - Bread & Cereal Products
707 - Oils & Fats
708 - Sauces & Spices
709 - Convenience Food
710 - Spreads & Sweeteners
711 - Baby Food
712 - Pet Food
801 - Cigarettes
802 - Smoking Tobacco
803 - Cigars
804 - E-Cigarettes
901 - Household Cleaners
902 - Dishwashing Detergents
903 - Polishes
904 - Room Scents
905 - Insecticides
1001 - Cosmetics
1002 - Skin Care
1003 - Personal Care
1004 - Fragrances
1101 - Toilet Paper
1102 - Paper Tissues
1103 - Household Paper
1104 - Feminine Hygiene
1105 - Baby Diapers
1106 - Incontinence
1202 - TV, Radio & Multimedia
1203 - TV Peripheral Devices
1204 - Telephony
1205 - Computing
1206 - Drones
1301 - Refrigerators
1302 - Freezers
1303 - Dishwashing Machines
1304 - Washing Machines
1305 - Cookers & Oven
1306 - Vacuum Cleaners
1307 - Small Kitchen Appliances
1308 - Hair Clippers
1309 - Irons
1310 - Toasters
1311 - Grills & Roasters
1312 - Hair Dryers
1313 - Coffee Machines
1314 - Microwave Ovens
1315 - Electric Kettles
1401 - Seats & Sofas
1402 - Beds
1403 - Mattresses
1404 - Closets, Nightstands & Dressers
1405 - Lamps & Lighting
1406 - Floor Covering
1407 - Kitchen Furniture
1408 - Plastic & Other Furniture
1501 - Analgesics
1502 - Cold & Cough Remedies
1503 - Digestives & Intestinal Remedies
1504 - Skin Treatment
1505 - Vitamins & Minerals
1506 - Hand Sanitizer
1601 - Toys & Games
1602 - Musical Instruments
1603 - Sports Equipment
items[].name String No

Name of the item
items[].partNumber String No

SKU number
items[].additionalQuantityDefinitions[] Array No
items[].additionalQuantityDefinitions[].typeCode String Yes

Item additional quantity value UOM:
example PFL=percent of alcohol
items[].additionalQuantityDefinitions[].amount Number Yes

An Item's additional quantity value:
example is percent of alcohol
items[].goodsCharacteristics[] Array No
items[].goodsCharacteristics[].typeCode String Yes

Please contact Express country representative to provide all applicable codes
items[].goodsCharacteristics[].value String Yes

Value related to the code
items[].weight Number No

Weight of the item
items[].weightUnitOfMeasurement String No

Unit of measurement

Possible values:

  • "metric"
  • "imperial"
items[].quantityType String No

Please provide quantitiy type. prt - part, box - box

Possible values:

  • "prt"
  • "box"
items[].unitPrice Number Yes

Product Unit price
currencyCode String Yes

Currency code for the item price (the product being sold) and freight charge. The Landed Cost calculation result will be returned in this defined currency
isInsuranceRequested Boolean No

Set this true if you ask for DHL Express insurance service
unitOfMeasurement String Yes

Please enter Unit of measurement - metric,imperial

Possible values:

  • "metric"
  • "imperial"
getTariffFormula Boolean No

Allowed values 'true' - tariff formula on item and shipment level will be returned, 'false' - tariff formula on item and shipment level will not be returned
isCustomsDeclarable Boolean Yes

Set this to true is shipment contains declarable content
charges[] Array No

Please provide any additional charges you would like to include in total cost calculation
charges[].currencyCode String Yes
charges[].typeCode String Yes

Possible values:

  • "insurance"
  • "freight"
  • "additional"
charges[].amount Number Yes
isDTPRequested Boolean No

Set this to true if you want DHL EXpress product Duties and Taxes Paid outside shipment destination
getCostBreakdown Boolean Yes

Allowed values 'true' - item cost breakdown will be returned, 'false' - item cost breakdown will not be returned
productCode String No

Please enter DHL Express Global Product code
getQuotationID Boolean No

Allowed values 'true' - quotation ID on shipment level will be returned, 'false' - quotation ID on shipment level will not be returned

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