DHL eCommerce BYOCA Guide
DHL eCommerce provides specialized, value-driven shipping solutions for B2C and B2B customers, focusing on lightweight (under 5 lb) international and domestic parcel delivery using the USPS as a carrier partner.
DHL eCommerce BYOCA (Bring Your Own Carrier Account) allows users to integrate their own DHL eCommerce account with EasyPost. This guide outlines how to configure, rate, and ship using existing DHL eCommerce credentials through EasyPost’s API.
Sign up for an EasyPost account to obtain a Test and Production API key. See Authentication and Key Management for more information.
Note: Negotiated rates are only available in Production mode.
- Contact DHL eCommerce to request a shipper account. A representative will be in touch for additional details regarding the account.
- Inform DHL eCommerce about using EasyPost’s API for label purchases.
- Acquire rates and align any additional shipping needs.
- Obtain the following production and test account credentials:
- DHL eCommerce Solutions Client ID
- DHL eCommerce Solutions Client Secret
- DHL eCommerce Solutions Pickup ID
- DHL eCommerce Solutions Distribution Center
- Input carrier-specific credentials on the Carrier Account Dashboard for comprehensive rate access.
The API structure specified by EasyPost can also be used to add the DHL eCommerce Wallet account.
curl -X POST https://api.easypost.com/v2/carrier_accounts \
-u "$EASYPOST_API_KEY": \
-H 'Content-Type: application/json' \
-d '{
"carrier_account": {
"type": "DhlEcsAccount",
"description": "DhlEcsAccount",
"credentials": {
"client_id": "VALUE",
"client_secret": "VALUE",
"distribution_center": "VALUE"
},
"test_credentials": {
"client_id": "VALUE",
"client_secret": "VALUE",
"distribution_center": "VALUE"
}
}
}'
Download an EasyPost Client Library or utilize the REST API with cURL.
Examine the EasyPost Objects section to understand the API's structure, which is critical for constructing requests and interpreting responses.
DHL eCommerce (BYOCA) is a Live Rating integration, enabling real-time rate retrieval for shipments created via EasyPost.
- When creating a shipment, EasyPost requests DHL eCommerce for shipment rates specific to the user’s DHL eCommerce account.
- The rates provided are directly from DHL eCommerce, tailored to the specific account details of the user.
- In cases of discrepancies or incorrect rates, users are advised to contact their DHL eCommerce account representative.
- The representative can then update the rates in DHL eCommerce’s database to ensure accuracy for the user’s account.
Service levels included with the EasyPost DHL eCommerce BYOCA account provide nationwide domestic services and U.S. export coverage to over 220+ countries worldwide. Visit DHL eCommerce’s website for detailed information on domestic and international shipping services.
For international shipping via DHL eCommerce, it’s important to understand two INCOTERMS: DDU and DDP, which dictate the payment of important duties and taxes:
- DDU: The recipient is responsible for paying any import duties and taxes.
- DDP: The shipper pays all costs, including import duties and taxes, ensuring hassle-free delivery for the recipient.
Choosing between DDU and DDP affects how duties and taxes are managed, influencing the overall shipping process. See DDP vs DDU for E-Commerce Business for more information.
Domestic
- DHL Parcel Expedited
- DHL Parcel Expedited Max
- DHL Parcel Ground
- DHL Bound Printed Matter Expedited
- DHL Bound Printed Matter Ground
- DHL Parcel Return Ground
- DHL Parcel Return Light
- DHL Parcel Return Plus
International
- DHL Parcel International Direct
- DHL Parcel International Standard
- DHL Packet International
Canada to US International (Canada-based account required)
- DHL Parcel International Direct MAX
- DHL Parcel International Direct Priority
- DHL Parcel International Direct Standard
DHL eCommerce may not return rates for specific services during a standard rating call with EasyPost. However, these services can still be accessed through the API using a unique method known as the ‘one-call buy'.
There are no predefined packages for DHL eCommerce.
With EasyPost, the process for generating shipping labels for DHL eCommerce is the same as generating them for any other carrier.
Review the Getting Started Guide for help generating a shipping label.
One-call buys enable streamlined label purchasing through the EasyPost API by consolidating multiple operations into a single API request. This feature is designed to simplify and accelerate the shipping process by combining the creation of a shipment, retrieval of rates, and purchasing the shipping label into one efficient step.
See Reducing API Response Times for more information.
DHL eCommerce supports PNG and ZPL labels.
The standard label size is 4 x 6.
When shipping to a country with customs clearance, all shipments will be checked by customs in that country. Therefore, it is mandatory to include the customs forms with shipments.
EasyPost offers a Customs Guide that outlines the process for including customs information in shipments. This guide enables the automatic generation of required customs forms for international shipping between two countries.
Creating return labels with DHL eCommerce returns a nominal 1-cent rate during the rating call.
- DHL eCommerce bypasses the standard rating process for return labels.
- The rating call, however, enables users to review and select from available return services.
- Post label purchase and usage, DHL eCommerce bills for the return label through its billing system, applying the correct postage fees.
DHL eCommerce is committed to the safe handling and transportation of dangerous or hazardous goods. All shipments containing hazardous materials must be properly classified, described, packaged, marked, labeled, and in proper condition for transportation.
See Hazardous Goods and Unacceptable Shipments for DHL eCommerce policies on the shipping and handling of lithium batteries, goods classified under the Limited Quantity Guidelines, and Unacceptable Shipments.
DHL eCommerce BYOCA accommodates pickups based on individual agreements with customers. While regular pickups can be arranged directly with DHL eCommerce during the account registration process, they cannot be scheduled via the EasyPost API.
Manifesting DHL eCommerce shipments serves two primary functions:
-
Electronic Data Transmission: It fulfills the DHL eCommerce requirement of electronically transmitting shipment data.
-
Driver Manifest Shipment Summary: Generates a summary document needed for DHL eCommerce driver pickup.
Manifesting is not instantaneous and may take several minutes to complete and receive a manifest document.
Immediate receipt of a driver manifest summary is not possible; it becomes available shortly after the manifesting process:
-
Create a batch with a list of shipments (or add shipments to the batch throughout the day).
-
Batch Processing
- Option A: Wait approximately 1-3 seconds for the batch creation to complete.
- Option B: Monitor for a
batch.updatedwebhook event indicating thebatch.statehas changed tocreated.
Note: Initiating the next step during the “creating” status leads to errors.
-
Execute the manifest
scan_formbatch. -
Manifest Confirmation
- Option A: Wait up to five minutes and retrieve the
scan_formto confirm completion. - Option B: Use webhooks to wait for the
scan_form.updatedevent and obtain the manifest document URL at that time.
- Option A: Wait up to five minutes and retrieve the
DHL eCommerce tracking operates similarly to other carriers integrated with EasyPost.
- DHL may transfer packages to USPS for last-mile delivery within the United States.
- The accuracy of final delivery tracking is contingent upon DHL receiving and then conveying USPS updates to EasyPost.
EasyPost simplifies package tracking by offering two methods:
- Tracking with an existing number and carrier.
- Using a Tracker included with an EasyPost-purchased shipping label.
The service integrates webhooks for timely shipment updates. For detailed information on tracking methods, visit the Tracking Guide.
The Carrier Metadata endpoint can programmatically return information about service levels, predefined packages, supported features, and shipment options.
Use this information to quickly integrate and make educated decisions about the mix of carriers for shipping needs. Additionally, the Carrier Metadata endpoint is available to retrieve comprehensive information about all carriers on the EasyPost platform, enhancing decision-making for carrier services.
In addition to the guidance provided in our Carrier Guides, EasyPost offers support to assist with FAQs, troubleshooting issues, and inquiries related to the EasyPost platform.
Please visit the Help Center for more information.
For questions about getting started with the EasyPost API please Talk to a Shipping Expert or contact our Support team.