DHL Tracking (Independent Publisher) (Preview)

The Shipment Tracking API provides up-to-the-minute shipment status reports. Users of this API can: Retrieve tracking information for shipments, Identify the Deutsche Post DHL (DPDHL) service provider involved with the shipment, Verify DPDHL is using the correct delivery address. This can reduce the number of misdelivered shipments.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Seven Sigma
URL https://www.sevensigma.com.au/
Connector Metadata
Publisher Seven Sigma
Website https://www.dhl.com/
Privacy policy https://www.dhl.com/content/dam/dhl/local/global/core/documents/pdf/MO-core-lela-local-pdp-policy.pdf
Categories Commerce

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Get shipment tracking

Get shipment tracking

Get shipment tracking

Get shipment tracking

Parameters

Name Key Required Type Description
Tracking number
trackingNumber True string

The tracking number of the shipment for which to return the information.

Service to be used
service string

Hint which service (provider) should be used to resolve the tracking number.

Requester country code
requesterCountryCode string

Optional ISO 3166-1 alpha-2 country code represents country of the consumer of the API response. It optimizes the return of the API response.

Shipment country code
originCountryCode string

Optional ISO 3166-1 alpha-2 country code of the shipment origin to further qualify the shipment tracking number (trackingNumber) parameter of the request.This parameter is necessary to search for the shipment in dsc service.

Postal code
recipientPostalCode string

Postal code of the destination address to

Response language code
language string

ISO 639-1 2-character language code for the response.

Result offset
offset number

Pagination parameter. Offset from the start of the result set at which to retrieve the remainder of the results (if any).

Row Count
limit number

Pagination parameter. Maximal number of results to retireve.

Returns

Name Path Type Description
shipments
shipments array of object

Detailed information about one shipment

id
shipments.id string

tracking Number. http://schema.org/trackingNumber

service
shipments.service string

Service (provider) used to resolve this tracking number (id).

address
shipments.origin.address Placeaddress
servicePoint
shipments.origin.servicePoint PlaceservicePoint

Service Point

address
shipments.destination.address Placeaddress
servicePoint
shipments.destination.servicePoint PlaceservicePoint

Service Point

Shipment Event
shipments.status ShipmentEvent

An event in shipment delivery; also known as Milestone, Checkpoint, Status History Entry or http://schema.org/DeliveryEvent

details
shipments.details ShipmentDetails

Detailed information about one shipment

events
shipments.events array of ShipmentEvent

An event in shipment delivery; also known as Milestone, Checkpoint, Status History Entry or http://schema.org/DeliveryEvent

possibleAdditionalShipmentsUrl
possibleAdditionalShipmentsUrl array of string

Array of URLs to potentially additional matching shipments in the other services.

Definitions

Placeaddress

Name Path Type Description
countryCode
countryCode string

A short text string code (ISO 3166-1 alpha-2 country code) specifying the country.

postalCode
postalCode string

Text specifying the postal code for an address. https://gs1.org/voc/postalCode

addressLocality
addressLocality string

Text specifying the name of the locality, for example a city. https://gs1.org/voc/addressLocality

streetAddress
streetAddress string

The street address expressed as free form text. The street address is printed on paper as the first lines below the name. For example, the name of the street and the number in the street or the name of a building. https://www.gs1.org/voc/streetAddress

PlaceservicePoint

Service Point

Name Path Type Description
url
url string

Url of the service point

label
label string

Label of the service point

ShipmentEvent

An event in shipment delivery; also known as Milestone, Checkpoint, Status History Entry or http://schema.org/DeliveryEvent

Name Path Type Description
timestamp
timestamp string

A date value in ISO 8601 format (2017-06-21) or a combination of date and time of day (2017-06-21T14:07:17Z) (see Chapter 5.4 of ISO 8601).

addressLocality
location.address.addressLocality string

Text specifying the name of the locality, for example a city. https://gs1.org/voc/addressLocality

statusCode
statusCode string

Code of the event; These codes are high-level grouping statuses.

status
status string

Short description of the status - title

description
description string

Detailed description of the event

remark
remark string

Remark regarding the shipment status

nextSteps
nextSteps string

Description of the next steps

ShipmentDetails

Detailed information about one shipment

Name Path Type Description
timestamp
proofOfDelivery.timestamp string

A date value in ISO 8601 format (2017-06-21) or a combination of date and time of day (2017-06-21T14:07:17Z) (see Chapter 5.4 of ISO 8601).

signatureUrl
proofOfDelivery.signatureUrl string

DEPRECATED, this field is replaced by the documentUrl field which should be used instead.

documentUrl
proofOfDelivery.documentUrl string

The link to related electronic proof of delivery document.

proofOfDeliverySignedAvailable
proofOfDeliverySignedAvailable boolean

Proof Of Delivery Signed Available

totalNumberOfPieces
totalNumberOfPieces integer

Total number of items or pieces in the shipment

pieceIds
pieceIds array of string

Ids of all the items or pieces in the shipment