Add a DHL eCommerce account
This guide walks through setting up a DHL eCommerce account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field DHL eCommerce expects.
At a glance
Before you start
- A DHL eCommerce account in good standing, plus its API credentials. The required fields are listed in All DHL eCommerce settings below.
- Decide the account country and the default service and label format this account uses.
Open the carrier accounts page
In the Carriyo Dashboard, open Settings in the left sidebar. Under Carrier Management, choose Carrier Accounts, then click the + add icon to start a new account.
Open settings
Go to Carrier Accounts
Add a new carrier account
Pick DHL eCommerce
In the carrier picker, search for DHL eCommerce and click Select. Carriyo creates a DHL eCommerce account and opens the credential step.
Search for the carrier
Enter the basics
The first wizard page collects two fields:
- Account name
- A label that's meaningful to your team (e.g.
DHL eCommerce your country). Keep it short and unique. - Account country
- The country this account ships from. Determines the routes and services available.
Fill in the account name and country.
- 1Account Name
- 2Account Country
Enter your DHL eCommerce account details
Enter the required DHL eCommerce account details, then click Next. Every field is documented in All DHL eCommerce settings below, with examples and accepted values.
Fill in the DHL eCommerce account details.
- 1Client Id
- 2Password
- 3SoldTo Account Id
- 4Pickup Account Id
Select shipping service type.
- 1Shipping Service Type
Configure the account
The new account opens on its detail page. General settings work the same way for every carrier: the Active toggle, default label and service, and currency. See Add a carrier account for the full reference to these shared settings — default label, merchant access, going live, and common mistakes.
Go to the account page
View the account details
Set the default label format
Set up status callbacks
DHL eCommerce sends shipment status by webhook, but it has to be registered on DHL eCommerce's side. Copy the callback details from the account page and share them with your DHL eCommerce contact. This is a one-time setup.
Share callback settings with your carrier
Merchant access
On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.
Add merchants to this carrier account
All DHL eCommerce settings
Every field DHL eCommerce exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
5 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Client IdRequired | Text | Your DHL eCommerce API client ID, used with the password to obtain an access token. Example: NZmDkZGNjZwx5 |
| PasswordRequired | Secret | The API password (client secret) paired with your DHL eCommerce client ID. Example: ZwNmZQV0ZGH |
| SoldTo Account IdRequired | Text | The DHL billing account that shipments are charged to. Example: 0444444655 |
| Pickup Account IdRequired | Text | The DHL pickup account identifying where shipments are collected from. Required for label creation. Example: 0444444655 |
| Customer Account IdOptional | Text | Your DHL eCommerce customer account number, used for label generation and billing. Leave blank to default to the SoldTo account. Example: e.g., 1234567890 |
Service Options
3 fieldsDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Shipping Service TypeRequired | Select | Select the default DHL eCommerce product applied to shipments. Sent to DHL as the product code. Example: Parcel Domestic (PDO) Packet Plus International Priority Manifest (PPM)Packet Plus International Standard (PPS)Packet International Priority Manifest (PKM)Packet International Standard (PKD)Parcel International Direct Standard (PLT)Parcel International Direct Expedited (PLE) |
| IncotermsOptional | Select | Default incoterm deciding whether the shipper (DDP) or consignee (DDU) pays duties and taxes on cross-border shipments. Example: Select an Incoterm Duties Consignee Paid (DDU)Duties Shipper Paid (DDP) |
| Handover MethodOptional | Select | Choose how parcels enter the DHL network: DHL pickup from your location, or drop-off at a DHL service point. Example: e.g., Pickup Pickup (DHL collects the shipment from the client location.)Drop-Off (The client delivers the shipment to a DHL service point.) |
Shipper Details
12 fieldsEnter the shipper’s contact and address information if it differs from the pickup (ship-from) address. This information will appear on shipping labels and documentation. If left blank, the pickup details will be used by default.
| Field | Type | What to enter |
|---|---|---|
| Contact NameRequired | Text | — |
| Contact PhoneRequired | Text | — |
| Contact EmailOptional | Text | — |
| Company NameOptional | Text | — |
| CountryRequired | Text | Choose one of: AfghanistanAlbaniaAlgeriaAmerican SamoaAndorraAngola |
| StateOptional | Text | — |
| CityRequired | Text | — |
| AreaOptional | Text | — |
| Address 1Required | Text | — |
| Address 2Optional | Text | — |
| Address 3Optional | Text | — |
| Post codeRequired | Text | — |
Label
2 fieldsConfigure how your DHL eCommerce shipping labels will be generated and formatted for printing.
| Field | Type | What to enter |
|---|---|---|
| Label FormatOptional | Select | File format for generated labels: PDF for standard printers or ZPL for thermal label printers. Defaults to PDF. Example: PDF Format (Default) PDFZPL |
| Label LayoutOptional | Select | Number of labels per page layout. Defaults to 1x1 (one label per page). Example: 1x1 (Default) 1x14x1 |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| DHL eCommerce Shipment ID ReferenceOptional | Select | Choose which Carriyo reference is sent to DHL as the shipment ID. Defaults to the Carriyo shipment ID reference. Example: Carriyo Shipment ID Reference (Default) Carriyo ShipmentID ReferenceOrder ReferenceShipment Reference |
Capability notes
Behavior that follows from DHL eCommerce's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but DHL eCommerce has to register it on their side. Share the callback details from the account page with your DHL eCommerce contact (see step 5) — a one-time setup.