Find service points for selected carriers in a given area.
carrier_code to search service points for specific carriers, or set use_integration_carriers to true to use the carriers enabled in the authenticated integration’s settings.
carrier_code and use_integration_carriers are mutually exclusive. Exactly one of them must be provided.carrier.code in the response may differ from the requested carrier_code. This is expected behavior.
address, the structured address_* parameters, and latitude/longitude are mutually exclusive. Only one way of providing the reference point can be used in a single request.data.geocoding.status is not_found, the address could not be resolved and no service points are returned.
When the address is resolved, data.geocoding.precision can be used to understand how specific the match is.
This can help decide whether the result is precise enough for the current flow.
For example, a full address may still resolve only to postal_code or city, which means the search is based on a broader area than the full address.
limit results are returned.
The search area can be narrowed in two ways:
radius to return only service points within a given distance from the reference pointne_latitude, ne_longitude, sw_latitude, and sw_longitude to search within a bounding boxradius and the bounding box parameters are mutually exclusive. When using a bounding box, all four bounding box parameters must be provided.is_expired field.
In area-based searches, only service points that are considered fresh enough are returned. When service points are requested explicitly by their identifier, expired service points may still be included in the response.
limit to control the maximum number of service points returned for the use case.
For example, if only the 5 closest service points need to be shown, a lower limit can reduce response size and avoid returning unnecessary results.Basic Authentication using API key and secrets is currently the main authentication mechanism.
Country to retrieve service points for, as an ISO 3166-1 alpha-2 code.
"NL"
Carrier codes to filter results by.
["dhl", "postnl"]Filters service points to carriers enabled in the authenticated integration's settings.
Free-text address used as the reference point for the search.
"Stadhuisplein 10, Eindhoven"
Street of the reference address.
"Stadhuisplein"
House number of the reference address.
"10"
Postal code of the reference address.
"5611 EM"
City of the reference address.
"Eindhoven"
Latitude of the reference point.
51.435046
Longitude of the reference point.
5.479507
Latitude of the north-east corner of the bounding box.
51.49
Longitude of the north-east corner of the bounding box.
5.57
Latitude of the south-west corner of the bounding box.
51.38
Longitude of the south-west corner of the bounding box.
5.36
Search radius in meters from the reference point.
100 <= x <= 500005000
Carrier-specific identifiers of the service points to return.
["12345", "NL98765"]Filters results by carrier-specific shop type.
"packStation"
Filters results by general shop type. Use this to narrow results without having to handle each carrier's specific shop types separately.
servicepoint, locker, post_office, carrier_depot ["servicepoint", "locker"]Maximum number of service points to return.
1 <= x <= 200100
OK