Add a DHL Express account
This guide walks through setting up a DHL Express account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field DHL Express expects.
At a glance
Before you start
- A DHL Express account in good standing, plus its API credentials. The required fields are listed in All DHL Express 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 Express
In the carrier picker, search for DHL Express and click Select. Carriyo creates a DHL Express 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 Express 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 Express account details
Enter the required DHL Express account details, then click Next. Every field is documented in All DHL Express settings below, with examples and accepted values.
Enter dhl express shipper account number.
- 1DHL Express Shipper Account number
Fill in the DHL Express account details.
- 1API Key
- 2API Secret
Select product code.
- 1Product Code
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 Express sends shipment status by webhook, but it has to be registered on DHL Express's side. Copy the callback details from the account page and share them with your DHL Express 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 Express settings
Every field DHL Express exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
9 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Shipper Account numberRequired | Text | Your DHL Express shipper account number, used as the default payer for shipping charges. Example: 413712407 |
| API KeyRequired | Text | The API Key generated for your app in the MyDHL API developer portal. Example: acme_api |
| API SecretRequired | Secret | The API Secret paired with your API Key from the MyDHL API developer portal. Example: K#7zP$8xY#8d |
| Show Payer Account numberOptional | Toggle | — |
| Show Duties Account numberOptional | Toggle | — |
| Payer Account numberOptional | Text | Enter only if a third-party DHL account pays for shipping; otherwise the shipper account is charged. Example: e.g. 18472393 |
| Duties & Taxes Account numberOptional | Text | Enter only when a separate DHL account pays import duties and taxes (DDP shipments). Example: e.g. 18472393 |
| Enable Consolidated Shipping (DHL Break Bulk Express Service)Optional | Toggle | — |
| Consolidated Shipping Account NumberOptional | Text | Free of Charge (FOC) DHL account used to book the parent of a consolidated shipment. Example: e.g. 18472393 |
Service Options
5 fieldsDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Product CodeRequired | Select | The default DHL Express product (service level) used to book shipments on this account. Example: EXPRESS WORLDWIDE - Non Document (P) EXPRESS 9:00 - Non Document (E)EXPRESS 10:30 - Non Document (M)EXPRESS 12:00 - Non Document (Y)EXPRESS WORLDWIDE - Non Document (P)PARCEL PRODUCT - Non Document (V)DOMESTIC EXPRESS 12:00 - Document (1) |
| Other Service CodesOptional | Multi | Optional DHL value-added services (e.g. signature, insurance) added to every shipment. DD - Duty & Tax PaidWY - Paperless TradePT - Data Staging 03II - InsuranceSA - Delivery SignatureSB - Content Signature |
| Customs DeclarableOptional | Toggle | Enable for international (dutiable) shipments. When on, full item details are included in the commercial invoice for cross-border, which speeds customs clearance and reduces held or returned packages. |
| IncotermOptional | Select | Default Incoterm declaring who pays duties and taxes on cross-border shipments (e.g. DDP, DAP). Example: CIF - Cost, Insurance and Freight CFR - Cost And FreightCIF - Cost, Insurance and FreightCIP – Carriage And Insurance Paid ToCPT – Carriage Paid ToDAF – Delivered At FrontierDAT – Delivered at Terminal |
| Default Item DescriptionOptional | Text | Fallback item description printed on the label/AWB. Resolution order: parcel description, then the first item's description, then this default. Set something meaningful so labels are never blank. |
Account Details
11 fieldsAccount-level configuration and defaults applied to shipments.
| 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 | — |
| Post codeOptional | Text | — |
Default Exporter Details
12 fieldsFill this if you wish to include the Exporter details in the DHL commercial invoice.
| 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 | — |
| Post codeOptional | Text | — |
| Registration NumbersRequired | Text | — |
Default Importer Details
12 fieldsFill this if you wish to include the Importer details in the DHL commercial invoice.
| 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 | — |
| Post codeOptional | Text | — |
| Registration NumbersRequired | Text | — |
Default Seller Details
13 fieldsFill this if you wish to include the Seller details in the DHL commercial invoice.
| Field | Type | What to enter |
|---|---|---|
| Use Shipment Pickup Details As Seller DetailsRequired | Toggle | — |
| 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 | — |
| Post codeOptional | Text | — |
| Registration NumbersRequired | Text | — |
Default Buyer Details
13 fieldsFill this if you wish to include the Buyer details in the DHL commercial invoice.
| Field | Type | What to enter |
|---|---|---|
| Use Shipment Dropoff Details As Buyer DetailsRequired | Toggle | — |
| 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 | — |
| Post codeOptional | Text | — |
| Registration NumbersRequired | Text | — |
Shipper Details
1 fieldFill this if you wish to include additional Shipper details the in the DHL commercial invoice.
| Field | Type | What to enter |
|---|---|---|
| Registration NumbersRequired | Text | — |
Receiver Details
1 fieldFill this if you wish to include additional Receiver details in the DHL commercial invoice.
| Field | Type | What to enter |
|---|---|---|
| Registration NumbersRequired | Text | — |
Dangerous Goods
3 fields| Field | Type | What to enter |
|---|---|---|
| Dangerous Goods Service CodeOptional | Text | The Dangerous Goods service code provided by DHL. |
| Dangerous Goods UN CodeOptional | Text | The UN code matching the selected dangerous-goods service. |
| Dangerous Goods Content IDOptional | Text | The content ID matching the selected dangerous-goods service. |
Label
4 fields| Field | Type | What to enter |
|---|---|---|
| Label TemplateOptional | Select | The DHL template and size used to generate the shipping label. Example: ECOM26_84_A4_001ECOM26_84_A4_001ECOM26_84_001ECOM_TC_A4ECOM26_A6_002ECOM26_84CI_001ECOM_A4_RU_002 |
| Waybill Document TemplateOptional | Select | The format of the DHL waybill document. Example: ARCH_8X4ARCH_8X4_A4_002ARCH_8X4ARCH_6X4ARCH_A4_RU_002 |
| Always download Waybill DocumentOptional | Toggle | Download the waybill document alongside the label for every shipment, including paperless and domestic ones. |
| Enable label-free returnsOptional | Toggle | DHL's paperless (label-free) return process, where customers scan a QR code instead of printing a label. Confirm DHL has enabled label-free returns on your account before turning this on. |
Commercial Invoice
8 fields| Field | Type | What to enter |
|---|---|---|
| Invoice TypeOptional | Select | The type of DHL commercial invoice to print (e.g. Commercial, Returns). Example: CommericalCommercialProformaReturns |
| Invoice TemplateOptional | Select | The template DHL uses to generate the commercial invoice. Example: COMMERCIAL_INVOICE_P_10COMMERCIAL_INVOICE_P_10COMMERCIAL_INVOICE_L_10COMMERCIAL_INVOICE_04RET_COM_INVOICE_A4_01 |
| Signature NameOptional | Text | The signatory's name. Setting it ensures the commercial invoice generated by DHL shows the correct signatory. Example: Jane Doe |
| Signature TitleOptional | Text | The signatory's title. Setting it ensures the commercial invoice generated by DHL shows the correct signatory. Example: Export Manager |
| Invoice RemarksOptional | Text | Optional remarks added to the commercial invoice. |
| Invoice DeclarationOptional | Text | Optional brand-specific declaration added to the commercial invoice. |
| Export ReasonOptional | Text | Optional purpose of export declared on the commercial invoice. |
| Export Reason TypeOptional | Select | Optional export reason type, as defined by DHL. PermanentTemporaryReturnUsed Exhibition Goods To OriginIntercompany UseCommercial Purpose Or Sale |
Reference Mappings
2 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| DHL Customer ReferenceOptional | Select | Choose one of: Example: Order Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
| DHL Invoice ReferenceOptional | Select | Choose one of: Example: Order Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
Document Upload
1 fieldCustoms and shipping documents to attach to shipments.
| Field | Type | What to enter |
|---|---|---|
| Required | Text | Choose one of: Certificate of Origin (COO)Commercial Invoice (CIN)Custom Declaration (DCL)Nafta Certificate of Origin (NAF)Other (INV)Proforma Invoice (PNV) |
Capability notes
Behavior that follows from DHL Express's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but DHL Express has to register it on their side. Share the callback details from the account page with your DHL Express contact (see step 5) — a one-time setup.