Shipment tracking - uniform (2023)

The Shipment Tracking API provides updated shipment status reports. Users of this API can:

• Get tracking information.
• Identify the Deutsche Post DHL (DPDHL) service provider involved in the shipment.
• Make sure DPDHL uses the correct shipping address. This can reduce the number of incorrectly delivered shipments.

extent

This API covers services provided by DPDHL under these brands:

• Post and parcels Germany
  • Registered Domestic, Registered Mail, Registered Return Receipt, Personal Registered Parcel, Registered, Value, Priority, Last Name, Registered International, Registered International Returned Receipt, Registered Personal International, Value Domestic, Registered Tracked International, Proof of Country, Postal Orders (PZA), Internet brand, goods post national, parcel
    
• DHL Express
  • DHL Express 9:00, DHL Express 10:30, DHL Express 12:00, DHL Express Express, DHL Express Envelope, DHL Express Easy, DHL Economy Select, DHL Express Domestic 9:00, DHL Express Domestic 10:30, DHL Express until 12 p.m., DHL Express until 6 p.m., DHL Medical Express, DHL Express Breakbulk
    
• DHL Global Forwarding (incl.DHL same day)
  • Air freight and sea freight transport
  • SameDay: SameDay Jetline unaccompanied shipping, SameDay Jetline accompanied shipping, SameDay Speedline, SameDay Sprintline
  • E-Commerce Shipments
    
• DHL Freight
  • EuroConnect, Eurapid, EuroLine, EuroNet, Customs Services, Cold Chain, Trade Shows & Events, Domestic Standard Pallet, Domestic Premium Pallet, Leading Logistics Provider, Transport Linked Warehousing, RailConnect, RailLine, Parcel, Home Delivery
    
• DHL e-commerce solutions
  • Cross-border products (Parcel Connect, Return Connect, Parcel International, Connect PLUS, Return International), worldwide air and road transport
  • Inland, Expressversand, Expressversand Max, Paket International, Paket International
  • Domestic Mail Asia Pacific
    
• DHL Supply Chain (will be reactivated in Q2 2023)

Not covered are:

• Services that require login (e.g. B2B systems).

The API provides tracking information to users:

• shipping location
• Delivery time of the shipment*
• Shipment Itinerary*
• Proof of delivery*
• Timestamp of sending
• Departure and destination information
• Shipment quantity*
• Item Level Events*
• Shipping dimensions*
• shipping weight*

* Not available for all DPDHL services.

Using the API

You must have the appropriate shipment tracking code and API subscription key (this key should be provided in the request header).

Examples of use cases

Find the location of the shipment

Using the API you can create a website or app that allows DPDHL customers to see the location of their shipment.

The API also identifies the DPDHL service provider involved.

Find out when the shipment arrives

Using the API you can create a website or app that allows DPDHL customers to see when to expect a delivery.

The system also identifies the DPDHL service provider involved.

Find out where the shipment was (location history)

Some customers want to know the itinerary of their shipments.

You can use the API to help create a website or application that allows DPDHL users to view location history data such as:

• weather sign
• Traveled places

The API also identifies the DPDHL service provider involved.

Make sure DPDHL ships to the correct address

They can help DPDHL customers to verify that the DPDHL service provider is using the correct delivery address.

You can use the API to create query forms that require users to enter a tracking ID for a shipment.

Find out which DPDHL service I used

You can help DPDHL customers to find out which DPDHL service provider will deliver their shipment.

You can use the API to create query forms that require users to enter a tracking ID for a shipment.

Get proof of delivery

With DHL's electronic proof of delivery, you'll receive delivery details and an image of the recipient's signature, if digitally captured. When the package is delivered by DHL, the recipient signs and writes their name on the driver's handheld device. The digital signature is available the next day after delivery.

Some customers want proof of delivery because they want to invoice their customers.

The API may provide users with proof of delivery.

The API also identifies the DPDHL service provider involved.

Find out about delivery delays

Some customers want to be informed about possible delivery delays.

The API can provide you with information about possible shipping delays.

The API also identifies the DPDHL service provider involved.

Customize my web application

You can use optional parameters and customize your web application according to user needs.

You can use the API to create language-specific web applications so that users can follow their broadcast in their native language.

get access

You must request credentials for any apps you develop

To register your app and get API subscription keys:

1. ClickMy applicationson the portal page.
2. Click on+Add applicationTaste.
   The Add Application form appears.
3. Fill out the form to add an application.
   You can choose the APIs you want to access.
4. When you have filled out the form, clickAdd applicationTaste.

certification

A subscription key is required for each call to the API. This key should be passed via the request header (DHL API key).

To view API subscription keys:

1. Out ofMy applicationsClick the name of your application on the screen.
   The details screen appears.
2. If you have access to more than one API, click the appropriate API name.
   Note:APIs are listed in the Credentials section.
3. Click onShowthe link among the stars that hidesconsumer key.
   Theconsumer keyit appears.

environments

Addressable API base URL/URI environments are:

Tariff Limits

Tariff limits protect the DHL infrastructure from suspicious requests that exceed defined thresholds.

When you request access to Shipment Tracking - Unified API for the first time, you will receive an initial level of service that makes this possible250 calls a daywith most1 call per second.

Additional tariff caps are available and assigned according to your specific use case. If you would like to request additional restrictions, continue with the following steps:

1. Build the application as described belowget accessSection.
2. ClickMy applicationson the portal page.
3. Click on the application you created
4. Scroll down to the list of APIs and click the "Request Upgrade" button.
5. Check out an example below:

When the limit is reached, you will receive an HTTP status code:

429: Too many requests.

More information

message format

This API usesRESTful JSON-Formatrepresent all resource possibilities and connect relationships between resources. Every answer without errorapplication/jsonThe media type is to be interpreted as defined inRESTful JSONSpecification.

JSON-LD

RESTful JSON responses are also includedJSON-LD compliantFormat.

General Conventions

Enumerations defined in API response entities can only contain a subset of possible values ​​(e.g. new values ​​can be added to the enumeration in future versions that don't break). If the value does not meet the customer's expectations, the customer should treat it as undefined.

error message format

In case of an errorapplication/problem+json(Details of the issue) is used to communicate the details of the error.

Date and time format

The date and time always correspond to the ISO 8601 format, e.g. e.g.:21.06.2017T14:07:17+2:00(date time) or06/21/2017 at 14:07:17(date time) or21.06.2017(Date). If no time zone information is provided, the time zone should be interpreted as the location of the shipping event in question.

responses to errors

This API can use the whole scopegeneral HTTP response statusas defined inRFC7231.
This API documentation only shows404to illustrate what an error response might look like.

Language

An API request can return localized messages (for example, a human-readable description of the shipment status code). It is possible to specify the preferred language of the calling user agentLanguagequery parameters. If the requested language isn't available but the broadcast is still found, the API returns a successful response and specifies the actual language of the response in the Content Language header.

API client recommendation

API clients should be aware that enums defined in API response entities may contain only a subset of possible values ​​(e.g. new values ​​may be added to the enum in future non-executing versions). If the value does not meet the customer's expectations, the customer should treat it as undefined.
We advise customers that optional fields may not be included in the response if their value is not defined.

Selection of the desired language

An API request can return localized messages (for example, a human-readable description of the shipment status code).

To select the desired language:

• Use the language query parameter when invoking the user agent.

If the requested language is not available but the broadcast is still found, the API returns a successful response and marks the actual response language incontent languageletterhead.

Allowed HTTP Methods

Questions and answers about DHL packages

DHL PACKAGE (Germany

You can book in addition to our parcel services in Germanyrecipient zip codeat your request. This will give you more detailed information about the shipment.

DHL Parcel Netherlands

For our parcel services in the Netherlands you can addrecipient zip codeat your request. This gives you more detailed information, such as status information.

An example API request

Example of a simple HTTP request

curl -X GET 'https://api-eu.dhl.com/track/shipments?trackingNumber=7777777770' -H 'DHL-API-Key:PasteHere_ConsumerKey'

Explanation of a simple example of an HTTP request

Example of a detailed HTTP request

curl -X GET 'https://api-eu.dhl.com/track/shipments?trackingNumber=7777777770&service=express&originCountryCode=NZ&requesterCountryCode=GB' -H 'DHL-API-Key:PasteHere_ConsumerKey'

The cURL example contains these parameters:

Note:For more information on the available parameters, see the DHL Shipment Tracking API Reference Guide.

A simple Python code example

import http.clientimport urllib.parseimport jsonparams = urllib.parse.urlencode({ 'trackingNumber': '7777777770', 'service': 'express'})headers = { 'Accept': 'application/json', 'DHL-API -Key': 'ApiKeyHere'}connection = http.client.HTTPSConnection("api-eu.dhl.com")connection.request("GET", "/track/shipments?" + params, "", headers)response = Connection.getresponse()status = Response.statusreason = Response.reasondata = json.loads(response.read())print("Status: {} i razlog: {}".format(status, razlog))print(podaci )connection.close()

Details on the use of tracking data

• Data requested and received via the SHIPMENT TRACKING API – UNIFIED API, such as B. Shipping Status, Estimated Delivery Time, including Tracking Number, are hereinafter referred to as “Tracking Data”.
• Tracking Data is confidential information as defined in the Communications section of the Developer Portal Terms of Use. Except as provided below, you may not, without DP DHL's prior written consent, provide Tracking Data to any third party and/or analyze such data in any way, modify and/or derive any data/information specifically for competitive purposes derive - And.
• Tracking information will be made available to you and/or the legal entity that you are authorized to represent (hereinafter "you"/"your") via this SHIPMENT TRACKING API - UNIFORM API provided you retrieve the appropriate tracking number in accordance with applicable law have . , particularly in the area of ​​data protection and competition law, and that you will only use Tracking Data for your own or legitimate purposes of tracking your customers.
• You may not combine Tracking Data with advertising or display it in any way that could be construed as advertising.
• Unless otherwise agreed, delete tracking information 30 days after completion of delivery (shipment) to the recipient.
• The tracking data is used in accordance with the following specification:
  • Display "Delivered by Deutsche Post DHL Group" in the text (minimum font size) as soon as it is presented/delivered to the recipient and/or your customers.
• The use and transmission of Tracking Data – including transmission to any of your subcontractors – will always be in accordance with applicable laws and regulations, including but not limited to data protection and competition/non-competition laws.
• If you are neither the sender nor the recipient of a DP DHL Group shipment, the tracking information relates to the following:
  • You must ensure that you are authorized to act on behalf of the sender and/or recipient;
  • You will inform the Sender and/or the Recipient of the limitations set forth in this User Guide and the Developer Portal General Terms of Use;
  • They inform the sender of the need to inform the recipient transparently about the processing of their personal data in accordance with the applicable data protection laws;
  • You will transparently inform the sender and/or recipient that use of your application may result in information subject to postal secrecy and data protection laws being disclosed to third parties (including you).

• Added "Provider" to the shipping model, including the "destinationProvider" field.

• The sample tracking number listed in the Open API Specification has been updated

• Added "parcel-uk" to the "Services" list.
• Added pieceIds to the shipping event model.
• Updated comments section for date/time format.

• Added "Same Day" to the "Services" list.

• Added post-de`toenumlist service.

• Updated to OpenAPI specification version 3.
• Added "serviceUrl" and "rerouteUrl" to the shipping model.
• Added "Reference" as a new reference type in the shipment detail model.
• Updated description for statusCode
  

• Fixed typo, maintenance release.

• Added "Consignment ID" to the list of possible answers.

• Added pagination.

• Release for maintenance

• AbJuly 31, 2020, the latest you can getMail/Letter Tracking(owned by Post & Paket Germany) with package tracking - Unified API. You can check more detailsHere.

• Updated vocabulary location.
• Added a note about general conventions in the comments section.
• "House Account" has been added to the list of possible answers.

• Removed example for "trackingNumber" and "recipientPostalCode".
• The format of the comments section of the API description has been changed.

• Added "Legal details on the use of tracking data".
• The default "Speed ​​Limits" have been adjusted

• Minor tippeller corrections in the comments section.
• Edited description of requesterCountryCode.

• The hostname introduced with version 1.0.4 has been corrected.

• Introduced new hostname and API key header name. The old names are deprecated but still functional for the time being. Switch to the new host and API header keys and stop using obsolete keys.
• Added a disclaimer in the Changelog section.
• Extended timestamp descriptions for value transfers can be ISO 8601 Date OR ISO 8601 Date/Time.
• broadcasts:
  • Added a description for the "PossibleAdditionalShipmentsUrl" link relationship at the shipment level.

• Minor correction of the field descriptions "requesterCountryCode", "originCountryCode", "recipientPostalCode" and "Language".
• Added estimatedTimeOfDeliveryRemark field to Shipment response model.
• Added various examples.
• Added "Document URL" and deprecated "Signature URL" in the "ProofOfDelivery" response model.
• Added "possibleAdditionalShipmentsUrl" to reflect matches in other backends/services with "Shipment" response model.
• Fixed some warnings related to JSON syntax.

• First launch