DHL

DHL is the global leader in the logistics industry. Specializing in international shipping, courier services and transportation.

Categories: Customer Support

Type: dhl/v1

Connections

Version: 1

API Key

Properties

Name	Label	Type	Description	Required
key	Key	STRING		true
value	API Key	STRING		true

Connection Setup

Navigate to https://developer.dhl.com/.
Click on the profile icon.
Click on Create App.
Enter apps name.
Enter Shipment Tracking - Unified and select it. When adding custom actions here you have to add additional APIs that your action will use.
Click on +.
Click on Create App.
Click on your new app.
Here you can see your API Key.
You will be able to use your API Key after your app is enabled by the DHL team.

Actions

Track Shipment

Name: trackShipment

Retrieves the tracking information for shipments.

Properties

Name	Label	Type	Description	Required
trackingNumber	Tracking Number	STRING	The tracking number of the shipment for which to return the information.	true

Example JSON Structure

{
  "label" : "Track Shipment",
  "name" : "trackShipment",
  "parameters" : {
    "trackingNumber" : ""
  },
  "type" : "dhl/v1/trackShipment"
}

Properties

Name	Type	Description
url	STRING	A link to current page.
prevUrl	STRING	A link to the previous page.
nextUrl	STRING	A link to the next page.
firstUrl	STRING	A link to the first page.
lastUrl	STRING	A link to the last page.
shipments	ARRAY Items [{}]	An array of unified tracking shipments.
possibleAdditionalShipmentsUrl	ARRAY Items [STRING]	An array of business services, where should be potentially shipment found.

Output Example

{
  "url" : "",
  "prevUrl" : "",
  "nextUrl" : "",
  "firstUrl" : "",
  "lastUrl" : "",
  "shipments" : [ { } ],
  "possibleAdditionalShipmentsUrl" : [ "" ]
}

How to find your tracking number

A tracking number or ID is a combination of numbers and possibly letters that uniquely identifies your shipment for national or international tracking.

Usually, the shipper or online shop is able to provide the tracking number or ID. If you have ordered a product in an online shop, the confirmation email or shipment tracking notification often contains the tracking number or ID.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page