12. Drop off points
12.A Get drop off points
12.A.1 Overview
Use this endpoint to receive a list of nearby drop off points, where shipments can be dropped off upon shipping. Results are ordered by distance from the provided postal code or coordinates.
12.A.2 Reference
URI | https://api.myparcel.nl/drop_off_points | |
Methods | GET | |
Required request headers | User-Agent: CustomApiCall/2 | |
URI parameters | None. | |
Query parameters | postal_code | string |
cc | country_code | |
carrier_id | carrier | |
distance | integer | |
latitude | coordinates | |
longitude | coordinates | |
Request body | None. | |
Response | HTTP/1.1 200 OK | |
Content-Type: application/json;charset=utf-8 | ||
Response body | array of drop off point objects |
12.A.3 Parameters
postal_code
Data type: string
Required: yes, unless longitude and latitude are used
The postal code for which to fetch drop off points in the area.
cc
Data type: country_code
Required: no
The country code for which to fetch the drop-off points. This endpoint can only be used in the Netherlands (cc=NL).
carrier_id
Data type: carrier
Required: no
carrier 1 (postnl)
and carrier 8 (ups)
are available.
distance
Data type: integer
Required: no
Provide the radius in kilometers for which you want to find drop off points. The default distance differs by carrier.
latitude
Data type: coordinates
Required: no
This provides the ability to find drop off points by coordinates. Should be used together with longitude.
longitude
Data type: coordinates
Required: no
This provides the ability to find drop off points by coordinates. Should be used together with latitude.