Find Locations by Address
dhl.find_locations_by_address
ActionBusiness appsconnection required
Calls the DHL API with the connection's credentials.
Find DHL service points, lockers and post offices near a postal address, with their opening hours and the services each one offers.
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
10 fields, 1 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 |
address_locality Town or city to search in. | string | No | — | — | Bonn |
postal_code Postal code to search around. | string | No | — | — | 53113 |
street_address Street and house number to search around. | string | No | — | — | Charles-de-Gaulle-Strasse 20 |
service_type Only return locations that offer this DHL service. | string | No | — | one of "parcel:pick-up-all", "parcel:drop-off-all", "parcel:pick-up", "parcel:pick-up-registered", "parcel:pick-up-unregistered", "parcel:drop-off", "parcel:drop-off-unregistered", "parcel:drop-off-unlabeled", "express:pick-up", "express:drop-off", "express:drop-off-account", "express:drop-off-easy", "express:drop-off-prelabeled", "express:drop-off-unlabeled", "letter-service", "postbank", "cash-on-delivery", "franking", "cash-service", "packaging-material", "postident", "age-verification", "handicapped-access", "parking" | — |
location_type Only return locations of this kind, such as a locker or a post office. | string | No | — | one of "servicepoint", "postoffice", "postbank", "locker", "pobox", "postbox" | — |
provider_type Only return locations run by this DHL business unit. | string | No | — | one of "parcel", "express", "freight" | — |
radius How far from the search point to look, in metres. | number | No | 500 | 0–1000000 | — |
limit Maximum number of locations to return in the response. | number | No | — | ≥ 1 | — |
hide_closed_shops True to leave out locations that are closed at the time of the request. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"address_locality": "Bonn",
"country_code": "DE",
"hide_closed_shops": false,
"postal_code": "53113",
"radius": 500,
"street_address": "Charles-de-Gaulle-Strasse 20"
}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": ""
}
]
}See Find Locations by Address 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.