Overview of the API capabilities.

Scope

The API allows tracking of Parcel DE shipments. It supports all products offered by DHL Parcel Germany.

Using the API

You will need:

• API Key which you can request here via the Get Access button for Sandbox and/or Production environments.
• Shipment IDs which you want to track

Get Access

To register your app and get your API subscription keys:

Use the "GetAccess" button (this will pre-populate this API if you create an app) or add the API to an existing app.

Approval is manual for this API. Please check back regularly. If you require very urgent approval, please raise a request via the contact form.

Authentication

Every call to the API requires a subscription key. This key needs to be specified in the request header (DHL-API-Key).

To view your API subscription keys:

1. From the My Apps screen, click on the name of your app.
   The Details screen appears.
2. If you have access to more than one API, click the name of the relevant API.
   Note: The APIs are listed under the "Credentials" section.
3. Click the Show link below the asterisks that is hiding the Consumer Key.
   The Consumer Key appears.

Environments

The addressable API base URL/URI environments are:

Shipment Numbers for testing on the Sandbox

last updated: Jan 18 2022

Here is a list of IDs you may try against the sandbox. There is no guarantee if and how long they will work, though.

JJD12345678909786824
JJD12345678909815964
JJD12345678909362270
JJD12345678909265981
JJD12345678909297662
JJD12345678909138159
JJD12345678909306343
JJD12345678909216608
JJD12345678909387988
JJD12345678909296072
JJD12345678909598716
JJD12345678909602386
JJD12345678909483058
JJD12345678909784122
JJD12345678909820242
JJD12345678909627991
JJD12345678909574355
JJD12345678909943811
JJD12345678909467639
JJD12345678909709106
JJD12345678909863968
JJD12345678909314049
JJD12345678909463103
JJD12345678909514664
JJD12345678909147449
JJD12345678909881457
JJD12345678909236712
JJD12345678909742996
JJD12345678909349878
JJD12345678909578635
JJD12345678909986565
JJD12345678909131709
JJD12345678909713370

Additional Information

Example requests

Simple HTTP request example

curl -X GET 'https://api.dhl.com/parcel/de/tracking/v1/shipments?shipmentId=1234' -H 'DHL-API-Key:PasteHere_ConsumerKey'

Sample Data

The API offers public data only (no personally identifiable information). Here is an example:

{
    "shipments": [
        {
            "shipmentId": "JJD12345678909358570",
            "recipient": {},
            "flags": {
                "delivery": false,
                "international": false,
                "return": false
            },
            "product": {
                "code": "00",
                "name": "DHL PAKET (parcel)"
            },
            "links": {
                "serviceUrl": "https://www.dhl.de/de/privatkunden.html?piececode=JJD12345678909358570&cid=c_dhl_gpsv_351_202108002_02",
                "rerouteUrl": "https://www.dhl.de/de/privatkunden.html?piececode=JJD12345678909358570&verfuegen_selected_tab=FIRST&cid=c_dhl_gpsv_351_202108002_01"
            },
            "events": [
                {
                    "status": "The instruction data for this shipment have been provided by the sender to DHL electronically",
                    "shortStatus": "PanReceived ",
                    "timestamp": "2021-09-22T07:51:00+02:00"
                },
                {
                    "status": "The shipment has been processed in the parcel center of origin",
                    "shortStatus": "InTransport",
                    "timestamp": "2021-09-22T07:51:00+02:00",
                    "location": "Regensburg",
                    "country": "Germany"
                },
                {
                    "status": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step.",
                    "shortStatus": "InTransport",
                    "timestamp": "2021-09-22T07:51:00+02:00",
                    "location": "Neuwied",
                    "country": "Germany"
                }
            ],
            "plannedDelivery": {
                "timeframe": {}
            },
            "currentEvent": {
                "status": "The shipment arrived in the region of recipient and will be transported to the delivery base in the next step.",
                "shortStatus": "InTransport",
                "timestamp": "2021-09-22T07:51:00+02:00",
                "location": "Neuwied",
                "country": "Germany"
            },
            "status": {
                "title": "OK",
                "status": 200,
                "detail": "Shipment search was successful."
            }
        }
    ],
    "status": {
        "title": "OK",
        "status": 200,
        "detail": "1 of 1 shipments OK. Details included."
    }
}

Legal Terms Content. This section is required for customer facing APIs.

Simon Wirges (simon.wirges@dhl.com) is the point of contact for this matter.