Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Service points by product
Delivery checkout

Get service points based on product.

The endpoint will return an array of the closest service points available to the destination, according to the parameters. The list will be sorted by distance when possible.

get/service_point/service_points

Query parameters

product_codestring required
Example:GLS_SD

Product code to find service points for.

country_codestring required
Example:DK

Country code to find service points within.

zipcodestring required
Example:5220

Zip code / Postal code.

citystring
Example:Odense SØ

Name of the city. It is recommended to include city in the request to increase accuracy.

addressstring
Example:Hvilehøjvej 25

Street address (street name and house number). It is recommended to include the address in the request to increase accuracy.

If this parameter is not present or the address cannot be validated, the results will be based on the zipcode coordinates alone.

quantityinteger

Defines the maximum amount of pickup points that will be returned.

service_point_typesstring[]

A specific service point type

Service point types. If not provided, will default to use all valid service point types for the given product.

[
  "SP",
  "BOX"
]

Response

Successful.

idstring

ID of the service point.

namestring

Name of the location of the service point.

addressstring

Address line 1 of the service point.

address2string

Second address line. Can be used for floor/room number, building name etc.

zipcodestring

Zip code of the pickup point.

citystring

City of the pickup point.

countrystring

Country code of the pickup point.

distanceinteger

Distance in meters between the pickup point and the requested location.

longitudenumber

Longitude of the pickup point. Together with latitude it defines the coordinates of the pickup point.

latitudenumber

Latitude of the pickup point. Together with longitude it defines the coordinates of the pickup point.

carrier_codestring

Carrier code of the pickup point. Defines which carrier the pickup point belongs to.

typestring nullable

The type of the service point. Types may vary from carrier to carrier.

opening_hoursstring[]

Opening hours in which parcels can be picked up at the location.

drop_off_allowedboolean

Whether or not the pickup point supports drop off of parcels.

pickup_allowedboolean

Whether or not the pickup point supports pickup of parcels.

Example response

[
  {
    "id": "95558",
    "name": "Påskeløkkens Købmand",
    "address": "Paaskeløkkevej 11",
    "zipcode": "5000",
    "city": "Odense C",
    "country": "DK",
    "distance": 250,
    "longitude": 10.4159,
    "latitude": 55.4086,
    "carrier_code": "gls",
    "type": "SP"
  }
]