Retrieve a list of service points
GET {{servicePointsBaseUrl}}/service-points?access_token=<string>&country=<string>&carrier=<string>&latitude=<string>&longitude=<string>&ne_latitude=<string>&ne_longitude=<string>&sw_latitude=<string>&sw_longitude=<string>&address=<string>&city=<string>&postal_code=<string>&house_number=<string>&radius=<integer>&weight=<double>&pudo_id=<string>&shop_type=<string>
Retrieve a list of available service points and the associated service point id. Only service points which are applicable to the carriers you have enabled in the integration settings menu will be returned. You can filter the results based on GPS location or address in combination with a search radius.
Notes
- If provided,
latitudeandlongitudespecify a reference point from which adistancewill be computed for each service point, and returned with the response. - Some carriers impose limits for certain service point, which means that they cannot accept parcels above a certain weight range. For this reason, you can specify the
weightparameter to ensure that only usable service points are returned. - If provided,
postal_codewill return a list of service points which are located exactly within the bounds of the specified postal code area. - The
addressparameter retrieves a list of service points closest to the referenced location. You can adjust the radius of the results through the 'radius' parameter. - The
addressparameter accepts postal codes in addition to street names.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
access_token | string | A JSON Web Token encoding either an “id” (user ID) or “iid” (integration ID) property. Alternatively, a public API key. | |
country | string | (Required) A country ISO 2 code | |
carrier | string | A comma-separated list of carrier codes (stringified) | |
latitude | string | Used as a reference point to calculate the distance of the service point to the provided location. | |
longitude | string | Used as a reference point to calculate the distance of the service point to the provided location. | |
ne_latitude | string | Latitude of the northeast corner of the bounding box. | |
ne_longitude | string | Longitude of the northeast corner of the bounding box. | |
sw_latitude | string | Latitude of the southwest corner of the bounding box. | |
sw_longitude | string | Longitude of the southwest corner of the bounding box. | |
address | string | Address of the destination address. Can accept postal code instead of the street and the house number. | |
city | string | City of the destination address. | |
postal_code | string | Postal code of the destination address. Using postal_code will return you service points located around that particular postal code. | |
house_number | string | House number of the destination address. | |
radius | string | Radius (in meter) of a bounding circle. Can be used instead of the ne_latitude, ne_longitude, sw_latitude, and sw_longitude parameters to define a bounding box. Minimum value: 100 meters. Maximum value: 50 000 meters. | |
weight | string | Weight (in kg.) of the parcel to be shipped to the service points. Certain carriers impose limits for certain service points that cannot accept parcels above a certain weight limit. | |
pudo_id | string | DPD-specific query parameter. | |
shop_type | string | Filters results by their shop type. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Requested-With | string | Identifies the request as one made using JavaScript | |
Accept | string |
RESPONSES
status: OK
[{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","extra_data":{},"name":"\u003cstring\u003e","street":"\u003cstring\u003e","house_number":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","homepage":"\u003cstring\u003e","carrier":"\u003cstring\u003e","country":"\u003cstring\u003e","formatted_opening_times":{"0":["\u003cstring\u003e","\u003cstring\u003e"],"1":["\u003cstring\u003e","\u003cstring\u003e"],"2":["\u003cstring\u003e","\u003cstring\u003e"],"3":["\u003cstring\u003e","\u003cstring\u003e"],"4":["\u003cstring\u003e","\u003cstring\u003e"],"5":["\u003cstring\u003e","\u003cstring\u003e"],"6":["\u003cstring\u003e","\u003cstring\u003e"]},"open_tomorrow":"\u003cboolean\u003e","open_upcoming_week":"\u003cboolean\u003e","distance":"\u003cnumber\u003e","shop_type":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","extra_data":{},"name":"\u003cstring\u003e","street":"\u003cstring\u003e","house_number":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","homepage":"\u003cstring\u003e","carrier":"\u003cstring\u003e","country":"\u003cstring\u003e","formatted_opening_times":{"0":["\u003cstring\u003e","\u003cstring\u003e"],"1":["\u003cstring\u003e","\u003cstring\u003e"],"2":["\u003cstring\u003e","\u003cstring\u003e"],"3":["\u003cstring\u003e","\u003cstring\u003e"],"4":["\u003cstring\u003e","\u003cstring\u003e"],"5":["\u003cstring\u003e","\u003cstring\u003e"],"6":["\u003cstring\u003e","\u003cstring\u003e"]},"open_tomorrow":"\u003cboolean\u003e","open_upcoming_week":"\u003cboolean\u003e","distance":"\u003cnumber\u003e","shop_type":"\u003cstring\u003e"}]