DHL
Declare a value for packages when shipping with DHL.
DHL credential requirements
Prior to shipping with DHL, you must configure credentials in the Shipium Console. You'll provide values for both production and test mode for your DHL client ID, DHL client secret, DHL client pickup account number, DHL Express key, DHL Express secret, DHL Express account number, and DHL Express key. You'll also need to supply your DHL client distribution center.

Declared value for packages
When shipping with DHL, you may optionally declare a value for the package being shipped. To declare a package value, you'll include the optional fields in the table below as part of the shipmentParameters
in your API call.
Reference field | Required/Optional | Field properties | Description |
---|---|---|---|
totalDeclaredValue .declaredValue | Optional | Number ($float) Ex.: 500 | The value to be passed through as the total monetary amount of the declared value for the package. This is what will be reimbursed if the package is damaged. If the declared value exceeds the carrier's free threshold, there may be a surcharge for passing a declared value. |
totalDeclaredValue .currencyCode | Optional | String Ex.: usd | The currency code for the declared value |
A snippet of the JSON request for the API call with the required fields is included. This example is for a single-parcel shipment. A multi-parcel shipment request would include these fields in multiParcelShipmentParameters
.
{
"shipmentParameters": {
"totalDeclaredValue": {
"declaredValue": 5000,
"currencyCode": "usd",
...
}
}
Resources
Your Shipium team member is available to help along the way. However, you might find these resources helpful:
Updated 13 days ago