Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Service points

List pickup points

Returns a list of the available and nearest pickup points based on input.

Usually the address information given should be the receivers address to find pickup points nearest their location.

The identification of the pickup points can be used/required when creating a shipment.

get/pickup_points

Query parameters

carrier_code'bpost' | 'bring' | 'budbee' | 'bws' | 'city_mail' | 'dao' | 'db_schenker' | 'dfm' | 'dhl_freight_se' | 'dhl_parcel' | 'dsv_xpress' | 'gls' | 'gls_de' | 'helthjem' | 'link_logistics' | 'packeta' | 'pdk' | 'post_nl' | 'post_nord' | 'posti' | 'ub_db_schenker_se' | 'ups' required
Example:gls

Carrier code to be included in the filter.

country_codestring required

Country code (ISO Alpha-2) to be included in the filter.

zipcodestring required
Example:5000

Zip code / Postal code.

citystring
Example:Odense

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

addressstring

Street address (contains street name and house number)

idstring

The ID of the pickup point. Used to look up a specific service point for a carrier. When used, zip code is no longer required. Some carrier may not support this parameter.

quantityinteger

Defines how many pickup points are being returned.

collect_pointsboolean

Set as true to get collect points for products like GLS Click&Collect

product_codestring

Used to, e.g., determine whether to return postfiliale (default) or packstations for DHL Parcel.

in_deliveryboolean

Filter on whether or not the pickup point supports drop-off of parcels.

out_deliveryboolean

Filter on whether or not the pickup point supports pickup of parcels.

Response

Successful.

numberstring

ID of the pickup point. Used when request a shipment to the specific pickup point.

idstring

ID of the pickup point. Used when request a shipment to the specific pickup point.

company_namestring

Name of the location of the pickup point.

namestring

Name of the location of the pickup point.

addressstring

Address line 1 of the pickup 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.

agentstring

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

carrier_codestring

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

opening_hoursstring[]

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

in_deliveryboolean

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

out_deliveryboolean

Whether or not the pickup point supports pickup of parcels.

Example response

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