DHL eCommerce credential requirements

Prior to shipping with DHL eCommerce, 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, and DHL client pickup account number. You'll also need to supply your DHL client distribution center.

You do not need to provide the DHL Express key, DHL Express secret, DHL Express account number, or DHL Express key when configuring your DHL eCommerce account.

DHL Express credential requirements

Prior to shipping with DHL Express, 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 eCommerce or DHL Express

When shipping with DHL eCommerce or DHL Express, 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.

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",
 ...
     }
}

Prepaid shipping charges for DDP shipments when shipping with DHL Express

When shipping internationally with DHL Express using the DDP (Delivered Duty Paid) incoterm, you can include prepaid shipping or handling charges on the commercial invoice. These charges represent freight costs that have already been paid, and including them helps ensure accurate duty and tax calculations for DDP shipments.

To include prepaid charges, add the invoicePrePaidAmount object within customsInfo in your API call. This field is sent to DHL Express only when the incoterm is set to ddp and the invoicePrePaidAmount.value is greater than 0.

Configure your account for prepaid charges

Using prepaid charges with DHL Express requires both carrier-level and Shipium account-level configuration.

Step 1: Confirm DHL Express account enablement. The prepaid charges feature requires account-level enablement with DHL Express. Contact your DHL Express representative to confirm that your account is configured for prepaid charges.

Step 2: Enable prepaid charges in the Shipium Console. Once your DHL Express account is configured, you'll need to enable the feature in your Shipium account settings. To access your carrier accounts, log in to the Shipium Console. From the navigation menu, select Configure and then Fulfillment Contexts. Within the applicable fulfillment context, select the Carrier Contracts tab and then select the desired DHL Express contract from the list at right. Next you'll select the Edit button for DHL Express in the Carrier Account section. Set the DHL Express Prepaid Charges Enabled flag to True.

If the DHL Prepaid Charges Enabled flag is not set to True and you include invoicePrePaidAmount in your API request, the Shipium API will return a validation error before the request is sent to DHL.

Request fields

Example API call with prepaid charges

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": {
        ...
        "customsInfo": {
            ...
            "incoterm": "ddp",
            "invoicePrePaidAmount": {
                "value": 25.50,
                "currencyCode": "USD"
            }
        }
    }
}

For more information about all available customs fields, see Customs Info for Shipments.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support