Browse APIs | DHL API Developer Portal

Document (DHL Global Forwarding)

Available

DHL GLOBAL FORWARDING: Air, Ocean and Ground Freight Forwarding

DOCUMENT: Download electronic documents from DHL Global Forwarding Document Management Systems

Region: Global

Used for: Additional Services

Division: DHL Global Forwarding

Push API (DHL Global Forwarding)

Available

Best for:

Subscribing to DHL Global Forwarding Push APIs
- Register for Push API subscription
- Provide your URL callback details
- Start to receive messages pushed from DHL to your API

Push APIs available

Business customers of DHL Global Forwarding
Air and Ocean Freight shipments

Region: Global

Used for: Shipping, Tracking

Division: DHL Global Forwarding

Shipment Booking (DHL Global Forwarding)

Available

Best for:

Creating shipment and quick bookings in transport management systems
Business customers of DHL Global Forwarding
Air, Ocean, Rail, and Road Freight shipments

Region: Global

Used for: Shipping

Division: DHL Global Forwarding

Shipment Label (DHL Global Forwarding)

Best for:

Generating DGF shipment labels
Business customers of DHL Global Forwarding
Air and Ocean Freight shipments

Region: Global

Used for: Shipping

Division: DHL Global Forwarding

Shipment Status (DHL Global Forwarding)

Available

Best for:

Providing access to the latest shipment event
Business customers of DHL Global Forwarding
Air and Ocean Freight shipments

Region: Global

Used for: Tracking

Division: DHL Global Forwarding

Shipment Tracking (DHL Global Forwarding)

Available

Best for:

Providing access to the shipment status at any time
Business customers of DHL Global Forwarding
Air, Ocean, Road and Rail Freight shipments

Region: Global

Used for: Tracking

Division: DHL Global Forwarding

Notifications

17-06-2024 18:38

DHL Global Forwarding Shipment Tracking API Update

Dear Customers,

We would like to inform you the following new features and update with the DGF Shipment Tracking API.

Features

Change Description

Availability

New ExternalBookingID field

The new ExternalBookingID can be found under $.ShipmentTracking.Shipment.ExternalBookingID. This field will contain the identification assigned by an external party for the booking made with DGF. It will only be visible when using the same reference number from the request parameter.

The ExternalBookingID can be populated either by mapping a reference number to the externalBookingID field in the shipment booking API or by entering the reference number on the TMS with a specific reference type (EBK).

The solution is currently available in the sandbox environment for customers to test. We will notify you about the availability of this solution for production in our next update. Additionally, we are planning to roll out this solution to other DGF tracking APIs, including shipment status, push API v1, and v2. Stay tuned for more updates.

Example:

GET https://api-sandbox.dhl.com/dgff/transportation/shipment-tracking?housebill=ExternalBookingID1

Response:

{

"ShipmentTracking": {

"MessageHeader": {

"Version": "2.2",

"MessageID": "ab387b42-5200-44f0-9500-ec1ed0fef891",

"CreationDateTime": "2024-06-14T09:03:30"

"Shipment": {

"HousebillNumber": "QB217666",

"ExternalBookingID": "ExternalBookingID1",

To understand the complete definition and structure of the message, we recommend referring to the Data Model available in our developer portal. You can find the relevant information under GET/shipment-tracking.

Sandbox - Available

PROD - TBA

For any objections or questions about the release, please reach out to us at dgf.apisupport@dhl.com.

Sincerely,

DGF API Team

You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription

15-02-2024 10:12

DHL Global Forwarding Shipment Tracking API Update

Dear Customers,

We hope this email finds you well. We are thrilled to share some exciting news with you regarding our DGF shipment tracking API. Today we just released the new emission details that will provide you with valuable insights into the environmental impact of your shipments.

With this update, you will have the ability to access the emission data for your shipments directly through our API. By utilizing the structure: $.ShipmentTracking.Shipment.Emissions, you will be able to retrieve accurate and up-to-date information on the emissions associated with your shipments.

Please visit our developer portal under the GET/shipment-tracking section, you will find the detailed Data Model, which will provide you with all the necessary information.

Sincerely,

DGF API Team

You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription

18-01-2024 16:40

DHL Global Forwarding Shipment Tracking API Update

Dear Customers,

We would like to inform you the following new features and update with the DGF Shipment Tracking API.

Features	Change Description	Availability
New Emission Details	We will now be providing emission details for shipments through our API. You will be able to access the emission data for your shipments from: $.ShipmentTracking.Shipment.Emissions To learn more about the structure of the message, please refer to the Data Model under GET/shipment-tracking from our developer portal.	1st February 2024
Duplicating Masterbill Fix	We would like to address a known issue that you may have encountered with some shipments regarding duplicate masterbill groups. We want to assure you that we are aware of this issue and planned to implement the fix to production soon.	1st February 2024
Additional timestamps (Ocean freight)	We will be adding four new timestamps to the existing timestamps of the Ocean Freight. The new timestamp codes and description are as follows: 1. G22 - Requested Shipping 2. A05 - Gated in at Port/Terminal 3. AID - All Import Documents Received 4. A13 - Gated out at Port/Terminal You may also refer to the DGF Tracking API Developer Portal Page under EventOceanCode for the full list.	1^st February 2024

For any objections or questions about the release, please reach out to us at dgf.apisupport@dhl.com.

Sincerely,

DGF API Team

You are receiving this message because you have subscribed to notifications on the DHL API Developer Portal. If you want to unsubscribe from notifications click here: Cancel Subscription

Shipment Tracking v2 (DHL Global Forwarding)

Best for:

Providing access to the shipment tracking at any time
Business customers of DHL Global Forwarding
Air, Ocean, Road and Rail Freight shipments
Emissions information
Latest and historical routing information
Masterbill, Container and Exceptions information for registered users

Region: Global

Used for: Tracking

Division: DHL Global Forwarding