GET /shipments/{shipmentTrackingNumber}/tracking

The Tracking service retrieves tracking statuses for a single DHL Express Shipment

Servers

Path parameters

Name Type Required Description
shipmentTrackingNumber String Yes

DHL Express shipment identification number

Request headers

Name Type Required Description
Plugin-Version String No

Please provide version of the plugin (applicable to 3PV only)

Accept-Language String No

Format {3-character language code}

Default value: "eng"

Shipping-System-Platform-Version String No

Please provide version of the shipping platform (applicable to 3PV only)

Webstore-Platform-Version String No

Please provide version of the webstore platform (applicable to 3PV only)

Message-Reference-Date String No

Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2

Webstore-Platform-Name String No

Please provide name of the webstore platform (applicable to 3PV only)

Shipping-System-Platform-Name String No

Please provide name of the shipping platform(applicable to 3PV only)

Message-Reference String No

Please provide message reference

Plugin-Name String No

Please provide name of the plugin (applicable to 3PV only)

Query parameters

Name Type Required Description
requestGMTOffsetPerEvent Boolean No

Query parameter to request to return GMT Offset of each event in response, for both shipment level and piece level.

Possible values:

  • true
  • false
levelOfDetail String No

Possible values:

  • "shipment"
  • "piece"
  • "all"

Default value: "shipment"

trackingView String No

Possible values:

  • "bbx-children"
  • "all-checkpoints"
  • "all-checkpoints-with-remarks"
  • "advance-shipment"
  • "shipment-details-only"
  • "last-checkpoint"

Default value: "all-checkpoints"

requestControlledAccessDataCodes Boolean No

Query parameter to request to return values of controlled access code fields in response.

Possible values:

  • true
  • false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.