Scope

The following operations are allowed in the Tracking API:

All tracking requests should be authorized for the Pickup. This means that the tracking results will be returned only if the requested package is present within one or more of the authorized pickups for the API user.

We recommend that you track a package using the

packageId or the dhlPackageId.

Workflow

There are many ways to track a package. Using one of the package identifiers:

• packageId
• dhlPackageId

• trackingId 
   

  plus

• pickup (optional)

A single tracking request supports up to 10 package identifiers of the same kind. Use pickup as an additional query parameter in order to search for the package within a specific pickup.

There are many ways to track a group of packages. Using -

• manifestId
• pickup, startDate, endDate
• pickup, startDate, endDate plus any of the following parameters
  • city
  • state
  • country
  • postalCode
  • orderedProductId

Any combination of one or more parameters of the above fields are also supported.

endDate should be within 7 days of startDate

When tracking a group of packages, all searches can be paginated using the following two parameters:

• offset
• limit

/tracking/v4/package/open?pickup=5119000&startDate=20190701&endDate=20190707&offset=5&limit=10

The default offset value is zero if not provided in the request. The max limit supported is 10.

When the results run into multiple pages, the links object in the response provides the URL for the prev and next page with preset offset and limit values. If there is no links object in the response, then there is no prev or next page available. The total element in the response provides the total number of packages for the query across all the pages.

Tracking IDs

There are multiple references for trackingId possible for a package. In order to minimize the complexity, all of them have been grouped under a single identifier called the trackingId. Any of the below identifiers will be supported in the query parameter when searching using the identifier trackingId.

These could be:

• DSP Mail Identifier trackingId
• Delivery Confirmation Number (Delcon) deliveryConfirmationNumber
• IMb code intelligentMailBarCode
• Overlabeled IMb Code overlabeledintelligentMailBarCode
• Overlabeled DSP number overlabeledDSPNumber

For consistency, the trackingId returned in the response of the Tracking API will always be the 'DSP Mail Identifier' even though the query searches for other identifiers mentioned above.

We recommend using the DSP Mail Identifier as the trackingId reference in your system. Other references are supported mainly for legacy customers.

In addition to the tracking history, the API response also provides additional information related to the package -

• pickup Detail pickupDetail
• package Detail package
• Recipient information recipient

This information is for reference only and we strongly recommend that this information not be made public if you're using this API to display results in a public tracking page.