View as Markdown
DHL icon

DHL ACTION

Get Tracking Information

Get tracking information for shipments. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's DHL account once, then configure and run Get Tracking Information from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "dhl-get-tracking",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    dhl: { authProvisionId: "apn_xxxxxxx" },
    trackingNumber: "Tracking Number",
    service: "Service",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Tracking Information inputs
Property Type Description
trackingNumber Tracking Number string
The tracking number of the shipment to get tracking information for
Required
service Service string
The service of the shipment to get tracking information for
Optional
requesterCountryCode Requester Country Code string
Optional ISO 3166-1 alpha-2 country code represents country of the consumer of the API response.
Optional
originCountryCode Origin Country Code 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.
Optional
recipientPostalCode Requester Postal Code string
Postal code of the destination address
Optional
language Language string
ISO 639-1 2-character language code for the response. This parameter serves as an indication of the client preferences ONLY. Language availability depends on the service used.
Optional
limit Limit integer
Maximum number of events to be returned in the response. Default: 5
Optional
offset Offset integer
Offset of the first event to be returned in the response. Default: 0
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
dhl-get-tracking
Version
0.0.3
App
DHL
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes