Add a DHL eCommerce Americas account
This guide walks through setting up a DHL eCommerce Americas account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field DHL eCommerce Americas expects.
At a glance
Before you start
- A DHL eCommerce Americas account in good standing, plus its API credentials. The required fields are listed in All DHL eCommerce Americas 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 Americas
In the carrier picker, search for DHL eCommerce Americas and click Select. Carriyo creates a DHL eCommerce Americas 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 Americas 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 Americas account details
Enter the required DHL eCommerce Americas account details, then click Next. Every field is documented in All DHL eCommerce Americas settings below, with examples and accepted values.
Fill in the DHL eCommerce Americas account details.
- 1Pickup Account Id
- 2Client Id
- 3Client Secret
- 4Distribution Center Id
Select shipping product type.
- 1Shipping Product 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
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 Americas settings
Every field DHL eCommerce Americas exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
4 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Pickup Account IdRequired | Text | DHL account identifying where shipments are collected. Required for label creation. Example: 0444444655 |
| Client IdRequired | Text | Your DHL eCommerce Americas API client ID. Provided during account setup and used to authenticate API requests. Example: NZmDkZGNjZwx5 |
| Client SecretRequired | Secret | Client secret paired with your DHL eCommerce Americas Client ID. Keep this confidential. |
| Distribution Center IdRequired | Text | DHL distribution centre for your pickup account, based on the nearest processing facility. Example: e.g., 2345678901 |
Service Options
3 fieldsDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Shipping Product TypeRequired | Select | DHL product/service the shipment is booked against; determines the product code sent to DHL for domestic or international parcels. DHL SmartMail Parcel / Parcel Plus Expedited (EXP)DHL SmartMail Parcel Expedited Max (MAX)DHL SmartMail Parcel / Parcel Plus Ground (GND)DHL SmartMail BPM Expedited (BEX)DHL SmartMail BPM Ground (BGN)DHL Parcel International Direct (PLT) |
| Shipping Service TypeOptional | Select | Optional add-on service. Signature Confirmation is not supported for international products. Delivery Confirmation (DELCON)Signature Confirmation (SIGCON) |
| Shipping Service Endorsement TypeOptional | Select | USPS ancillary endorsement for handling undeliverable pieces and requesting the addressee's new address. Address Service RequestedForwarding Service RequestedChange Service RequestedReturn Service Requested |
Package Details
2 fieldsConfigure your DHL eCommerce package details.
| Field | Type | What to enter |
|---|---|---|
| Package TypeOptional | Select | Packaging type sent to DHL, used to determine dimensional weight. BoxPolybagTube |
| Default Parcel DescriptionOptional | Text | Fallback contents description sent to DHL when a shipment has no item description. |
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 | — |
Return Details
12 fieldsEnter the return 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
1 fieldConfigure 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. PNG suits standard printers; ZPL is for thermal label printers. Defaults to PNG. Example: PNG Format (Default) PNGZPL |
Reference Mappings
4 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| DHL eCommerce Package IDOptional | Select | Which Carriyo reference is sent to DHL as the package ID. Defaults to the Carriyo shipment ID. Example: Carriyo Shipment ID Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
| DHL eCommerce Package ReferenceOptional | Select | Carriyo reference printed beneath the package ID and its barcode on the label. Defaults to the Carriyo shipment ID. Example: Carriyo Shipment ID Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
| DHL eCommerce Billing Reference 2Optional | Select | Which Carriyo reference is sent to DHL as the primary billing reference, used to aggregate billing data. Defaults to the Carriyo shipment ID. Example: Carriyo Shipment ID Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
| DHL eCommerce Billing Reference 2Optional | Select | Which Carriyo reference is sent to DHL as the secondary billing reference, used to aggregate billing data. Defaults to the Carriyo shipment ID. Example: Carriyo Shipment ID Reference (Default) Order ReferenceShipment ReferenceAlternate Reference |
Capability notes
Behavior that follows from DHL eCommerce Americas's capabilities. Read these before you go live.
shipped, in_transit, delivered…) reach Carriyo automatically. No polling, and nothing to set up on your side.