HomeAPI Reference12. Drop off points

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.
When creating Instabox shipments, it is required to provide a drop-off point.

12.A.2 Reference

URIhttps://api.myparcel.nl/drop_off_points
MethodsGET
Required request headersUser-Agent: CustomApiCall/2
URI parametersNone.
Query parameterspostal_codestring
cccountry_code
carrier_idcarrier
distanceinteger
latitudecoordinates
longitudecoordinates
Request bodyNone.
ResponseHTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Response bodyarray 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 undefined (undefined) , carrier 5 (Instabox), 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.

12.A.4 Examples

Get drop off points for 2132JE for Instabox

Edit this page
Last updated: 
Contributors Richard Perdaan