DHL Express MyDHL API

DHL Express MyDHL API offers both domestic and international services for shipping to and from destinations worldwide.

This guide provides developers with the details needed to build DHL Express MyDHL API shipping capabilities into your ShipEngine workflows.

Requirements

Shipping Requirements

Connect Account

You can connect a DHL Express MyDHL API account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipEngine Dashboard.

Connect via Endpoint

carrier_name: dhl_express_mydhl

POST /v1/connections/carriers/:carrier_name

Sample request:

Copy

HTTPcURLJavaScriptNodeJSPHPPythonRubyC#JavaGoSwiftObjective-CPowerShell

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/dhl_express_mydhl HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "nickname": "My DHL Express MyDHL API account",
  "dhl_shipper_number": "123456789",
  "api_key`": "1234-abcd-5678-efgh-0129",
  "api_secret": "my-api-secret"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Connect via Dashboard

Steps to connect via dashboard coming soon!

Rates

DHL Express MyDHL API supports rate shopping with ShipEngine.

Service Details

Available DHL Express MyDHL API services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

Domestic Services

International Services

Shipping from Great Britain to Northern Ireland

DHL Express MyDHL API will support the B2B movement types for shipping from Great Britain to Northern Ireland, in accordance with the Windsor Framework.

Details about data requirements for DHL Express MyDHL API shipments to Northern Ireland are coming soon.

Return Services

DHL Express MyDHL API does not currently support support creating return labels.

Packages

The following carrier package types are available for DHL Express MyDHL API services:

Adding Shipment Insurance

DHL Express MyDHL API supports adding carrier insurance to shipments created in ShipEngine.

Review our insurance page for details on adding insurance to your shipments.

Label Support

Label Reference Fields

DHL Express MyDHL API supports adding custom label messages.

Label messages map in the following way:

Multi-Package Labels

DHL Express MyDHL API supports creating multi-package shipments with all available services.

See our Multi-Package Shipping page for details about creating multi-package labels.

Label Branding

DHL Express MyDHL API supports label branding.

Voiding Labels

DHL Express MyDHL API does not support voiding labels in ShipEngine.

Paperless Labels

DHL Express MyDHL API does not support paperless labels.

Customs Declarations

DHL commercial invoices are available to download from the forms_download object in the label response.

Delivery Confirmation

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

DHL Express MyDHL API supports certain advanced options, which you can add to the shipment object when creating a shipment or label.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

DHL Express MyDHL API does not require manifesting your shipments.

Scheduling Pickups

DHL Express MyDHL API does not support scheduling pickups using ShipEngine.

Service Points (PUDO)

DHL Express MyDHL API supports shipping to service points with their "Service Point" specific services.

When shipping to service points:

See our Intro to Service Points for more details about how to use service points with ShipEngine.

Tracking

ShipEngine's integration with DHL Express MyDHL API supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipEngine API.

Disconnecting Your DHL Express MyDHL API Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipEngine.