Skip to main content

DHL eCommerce UK Integration

Tom Higgs avatar
Written by Tom Higgs
Updated over a month ago

The DHL eCommerce UK courier connection integrates with the Parcel UK API from DHL's eCommerce division. This connection replaces the previously used DHL Parcel and UK Mail connections.

Note: DHL Parcel UK has been rebranded to DHL eCommerce UK.


Features

The service provides:

  • Parcel UK shipping and tracking.

  • Domestic pick up (UK).

  • Domestic (UK) and international delivery.


Prerequisites

Obtain credentials

Contact your DHL Account Manager to acquire the following credentials:

  • DHL Account Type.

  • DHL Pickup Account Number.

  • DHL Client ID.

  • DHL Client Secret.

Add roles and permissions

If you cannot access the DHL eCommerce UK page in Mintsoft, check you have the relevant permissions:

  1. Click Settings then Warehouse User Accounts.

  2. Find the user requiring access.

  3. Click Actions then Manage Roles.

  4. Expand the Group-Connect role group.

  5. Select the Connect-DHLeCommerceUK sub-role group.

  6. Click Update.

Note: These steps resolve 'Unauthorised' messages when accessing the DHL eCommerce UK page in Mintsoft.


Set up the DHL eCommerce UK connection

Once you have credentials from your DHL Account Manager, configure the connection in Mintsoft:

  1. Click Connect then Courier Integrations.

  2. Click DHL eCommerce UK then Add Account.

  3. (3PL only) Select the Client.

  4. Select the Warehouse or leave as ALL.

  5. Set your Account Type.

  6. Enter your DHL Pickup Account number.

  7. Select your preferred Label Format.

  8. Enter your DHL Client ID and DHL Client Secret.

  9. (Optional) Enable Tracking Events.

  10. Click Add.


Add new courier services

Retrieve service codes

  1. Click Connect then Courier Integrations.

  2. Click DHL eCommerce UK then click Get Services against the connection.

  3. The generated text contains the codes required to add new courier services.

You need the following information:

  • productNameForUI - The name of the service.

  • accountType - Identifies the Account Type:

    • ukDomestic: Enter DOMESTIC in Mintsoft.

    • internationalAir: Enter AIR in Mintsoft.

    • internationalRoad: Enter ROAD in Mintsoft.

  • productCode - The code of the courier service.

Add courier service codes

  1. Click Shipping Management then Extras.

  2. Click Courier Service Codes then Add New Courier Service Code.

  3. Select DHL eCommerce UK as the Courier.

  4. Enter the accountType into Extra Code 2.

  5. Enter the productNameForUI into the Description field.

  6. Enter the productCode into the Code field.

  7. (Optional) Add additional enhancements in the ExtraCode fields using the Mapping Spreadsheet for reference.

  8. Click Create.

Configure courier services

  1. Click Shipping Management then Couriers.

  2. Click ManageCourierServices next to your DHL eCommerce UK courier.

  3. Use the CourierServiceType drop-down to select a type (usually Standard or Express).

  4. Enter the productNameForUI in the Name field (can be renamed if needed).

  5. Enter the Tracking URL.

  6. If applicable, enter a Fuel Surcharge as a percentage (enter 0 if not applicable).

  7. Switch Active to ON.

  8. Click Add.

Map courier services

  1. Click Shipping Management then Extras.

  2. Click Courier Service Code Mappings then Add New Courier Service Code Mapping.

  3. Find the courier service you added in the CourierServiceId dropdown.

  4. Find the courier service code you added in the CourierServiceCodeId dropdown (search by product name).

  5. Click Map.

  6. Repeat for additional services.

Example service codes

Below is an example of courier service codes returned when clicking Get Services:

{"productCode":"200","productName":"Worldwide Air","productNameForUI":"Worldwide Air","shipmentType":"international","sortOrder":1,"dimensionsMandatory":true,"accountType":"internationalAir","shipmentIdentifierType":"Parcel UK","labelType":"express-uk","labelProductName":"Worldwide

When entering courier service codes:

  • Code: 200

  • Description: Worldwide Air

  • Extra Code 2: AIR


FAQ

Error when generating shipment

If you receive the error (ErrorException Occurred: The UserName field is required. The AuthenticationToken field is required. The AccountNumber field is required. The CollectionDate field is required. The ClosedForLunch field is required. The EarliestTime field is required. The LatestTime field is required) when generating a shipment for DHL Parcel UK, ensure you have migrated your account to DHL eCommerce UK using the method described above.

Did this answer your question?