Find Location by Keyword ID

dhl.find_location_by_keyword_id

ActionBusiness appsconnection required

Calls the DHL API with the connection's credentials.

Look up one DHL location directly by its keyword id, such as the number printed on a Packstation or a post office's branch number.

Ask about DHL All DHL nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: API key
Providers: DHL
Secret shape: the DHL API key (consumer key), or {"api_key": "…"}
Config it needs: base_url
Resolved by: config.connection_id, else node.connection_id

Configuration

3 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
country_code Two-letter ISO 3166-1 country code of the country to search in.	string	Yes	—	matches ^[A-Za-z]{2}$	DE
keyword_id The location's keyword id — the number that follows Packstation or Filiale.	string	Yes	—	—	402
postal_code Postal code of the location; some countries need it to resolve the id.	string	No	—	—	53113

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "country_code": "DE",
  "keyword_id": "402",
  "postal_code": "53113"
}

Output

One shape.

result

Field	Type	Example
locations The matching DHL locations, nearest first.	array	—
count How many locations the response carried.	number	—
locations[].url The API URL of this single location.	string	—
locations[].name The location's display name.	string	—
locations[].distance Distance from the search point, in metres.	number	—
locations[].location.keyword The location's keyword, such as Packstation.	string	—
locations[].location.keywordId The number that follows that keyword.	string	—
locations[].location.type One of servicepoint, postoffice, locker and so on.	string	—
locations[].location.ids Per-provider ids, each with locationId and provider.	array	—
locations[].place.address.countryCode Country code of the location.	string	—
locations[].place.address.postalCode Postal code of the location.	string	—
locations[].place.address.addressLocality Town or city of the location.	string	—
locations[].place.address.streetAddress Street and number of the location.	string	—
locations[].place.geo.latitude Latitude of the location.	number	—
locations[].place.geo.longitude Longitude of the location.	number	—
locations[].serviceTypes The DHL services this location offers.	array	—
locations[].openingHours Opening hours, one entry per day-of-week span.	array	—
locations[].closurePeriods Dates on which the location is closed.	array	—

{
  "count": 0,
  "locations": [
    {
      "closurePeriods": [],
      "distance": 0,
      "location": {
        "ids": [],
        "keyword": "",
        "keywordId": "",
        "type": ""
      },
      "name": "",
      "openingHours": [],
      "place": {
        "address": {
          "addressLocality": "",
          "countryCode": "",
          "postalCode": "",
          "streetAddress": ""
        },
        "geo": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "serviceTypes": [],
      "url": ""
    }
  ]
}

Related DHL nodes

See Find Location by Keyword ID run in a workflow.

In a technical demo we add the DHL connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales