Skip to main content
GET
Get closest service points

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Query Parameters

carrier
string
required

Known carrier code. Unknown codes return 422. A known carrier with no service points in the selected country is a valid filter and may return an empty result.

Examples:

"postnord"

"bring"

"dao"

"gls"

country
string
required

Valid ISO 3166-1 alpha-2 country code. Invalid codes return 422. A valid country with no service points for the selected carrier may return an empty result.

Required string length: 2
Examples:

"DK"

"SE"

"FI"

"NO"

"DE"

"ES"

"US"

"CN"

"CA"

postal_code
string
required

Postal/ZIP code

city
string

City name (improves accuracy)

street
string

Street address (improves accuracy)

query
string

Search query to filter service points by name or address

min_latitude
number

Southern boundary, inclusive. Must be less than or equal to max_latitude. Uses WGS 84 coordinates in decimal degrees. If any bounding-box coordinate is supplied, all four query parameters (min_latitude, max_latitude, min_longitude and max_longitude) are required. Omit all four to search without a bounding-box restriction. Missing, null, empty, out-of-range or reversed coordinates return 422.

Required range: -90 <= x <= 90
max_latitude
number

Northern boundary, inclusive. Must be greater than or equal to min_latitude. Uses WGS 84 coordinates in decimal degrees. If any bounding-box coordinate is supplied, all four query parameters (min_latitude, max_latitude, min_longitude and max_longitude) are required. Omit all four to search without a bounding-box restriction. Missing, null, empty, out-of-range or reversed coordinates return 422.

Required range: -90 <= x <= 90
min_longitude
number

Western boundary, inclusive. Must be less than or equal to max_longitude. Longitude intervals must not wrap across the antimeridian. Uses WGS 84 coordinates in decimal degrees. If any bounding-box coordinate is supplied, all four query parameters (min_latitude, max_latitude, min_longitude and max_longitude) are required. Omit all four to search without a bounding-box restriction. Missing, null, empty, out-of-range or reversed coordinates return 422.

Required range: -180 <= x <= 180
max_longitude
number

Eastern boundary, inclusive. Must be greater than or equal to min_longitude. Longitude intervals must not wrap across the antimeridian. Uses WGS 84 coordinates in decimal degrees. If any bounding-box coordinate is supplied, all four query parameters (min_latitude, max_latitude, min_longitude and max_longitude) are required. Omit all four to search without a bounding-box restriction. Missing, null, empty, out-of-range or reversed coordinates return 422.

Required range: -180 <= x <= 180
page
integer
default:1

Page number, starting at 1. Omit it to retrieve the first page.

Required range: x >= 1
per_page
integer
default:10

Number of service points per page. Keep the search address and all filters unchanged when following pagination links.

Required range: 1 <= x <= 50

Response

Service points ordered by increasing distance, with UUID as the tie-breaker. Filters, including the bounding box, are applied before pagination. The data array is empty when no points match, including for a known carrier with no service points in the selected valid country.

data
object[]
required

Navigation links for a page-paginated collection. URLs preserve the selected filters and page size. First and last URLs are present even when the collection is empty; unavailable previous and next pages are null.

meta
object
required

Page pagination metadata, including page numbers and total count.