8. Delivery options

8.A Get delivery options

This endpoint has a rate limit. For more information, see rate limiting.

8.A.1 Overview

Defaults
Get the delivery options for a given location and carrier. If none of the optional parameters are specified then the following default will be used: If a request is made for the delivery options between Friday after the default cutoff_time (15h30) and Monday before the default cutoff_time (15h30) then Tuesday will be shown as the next possible delivery date.

Objects
Upon success two arrays are returned; one for DeliveryOptions and one for PickupOptions objects is returned. This object contains delivery date, time and pricing. Upon error an Error object is returned.

To show delivery options to customers, you can use our javascript code. Use our sandbox for an example and easier integration.

8.A.2 Reference

URIhttps://api.myparcel.nl/delivery_options
https://api.myparcel.nl/pickup_locations
MethodsGET
Rate Limit30 requests in 5 minutes
URI parameters
Query parameterscccountry_code
postal_codestring
numberstring
citystring
streetstring
platformplatform
carriercarrier
delivery_timetime
delivery_datedate
cutoff_timetime
dropoff_daysweekday_digit
monday_deliveryboolean
dropoff_delayinteger
deliverydays_windowinteger
exclude_delivery_typedelivery_type
exclude_parcel_lockersboolean
latitudecoordinates
longitudecoordinates
Request bodyNone.
ResponseHTTP/1.1 200 OK
Content-Type:application/json;version=2.0 charset=utf-8
Response bodyarray of DeliveryOptions or array of PickupOptions objects
Error responseHTTP/1.1 5xx < MESSAGE >
Error response bodyNone.
Error responseHTTP/1.1 503 < MESSAGE >
Error response body 503Error
Error response body Example {"data": {"delivery": [],"pickup": [],"message": "No results"},"errors": [{"code": 9,"message": "Example","human": "Example"}]}

8.A.3 Parameters

cc
Data type: country_code
Required: yes
The country code for which to fetch the delivery options. This endpoint can only be used in the Netherlands or Belgium ( cc=NL or cc=BE ).

postal_code
Data type: string
Required: yes.
The postal code for which to fetch the delivery options.

number
Data type: string
Required: yes
The street number for which to fetch the delivery options.

city
Data type: string
Required: no
Only available for carriers bpost and DPD. This can be used to narrow the search results for locations outside NL.

street
Data type: string
Required: no
This can be used to narrow the search results for locations outside NL.

platform
Data type: platform
Required: no
The platform where you want the data from

delivery_time
Data type: time
Required: no
The time on which a package has to be delivered.
Note: This is only an indication of time the package will be delivered on the selected date.

delivery_date
Data type: date
Required: no
The date on which the package has to be delivered.

cutoff_time
Data type: time
Required: no
This option allows the Merchant to indicate the latest cut-off time before which a consumer order will still be picked, packed and dispatched on the same/first set dropoff day, taking into account the dropoff-delay. Default time is 15h30. For example, if cutoff time is 15h30, Monday is a delivery day and there's no delivery delay; all orders placed Monday before 15h30 will be dropped of at PostNL on that same Monday in time for the Monday collection.

dropoff_days
Data type: weekday_digit
Required: no
This options allows the Merchant to set the days she normally goes to PostNL to hand in her parcels. By default Saturday and Sunday are excluded.

monday_delivery
Data type: boolean
Required: no
Monday delivery is only possible when the package is delivered before 15.00 on Saturday at the designated PostNL locations. Click here for more information concerning Monday delivery and the locations.
Note: To activate Monday delivery, value 6 must be given with dropoff_days , value 1 must be given by monday_delivery . And on Saturday the cutoff_time must be before 15:00 (14:30 recommended) so that Monday will be shown.

saturday_delivery
Data type: boolean
Required: no
Saturday delivery is only possible when the package is delivered before 15.00 on Friday at the designated bpost locations.
Note: To activate Saturday delivery, value 6 must be given with dropoff_days , value 1 must be given by saturday_delivery .

dropoff_delay
Data type: integer
Required: no
This options allows the Merchant to set the number of days it takes her to pick, pack and hand in her parcels at PostNL when ordered before the cutoff time. By default this is 0 and max is 14.

deliverydays_window
Data type: integer
Required: no
This options allows the Merchant to set the number of days into the future for which she wants to show her consumers delivery options. For example, if set to 3 in her check-out, a consumer ordering on Monday will see possible delivery options for Tuesday, Wednesday and Thursday (provided there is no drop-off delay, it's before the cut-off time and she goes to PostNL on Mondays). Min is 1. and max. is 14.

exclude_delivery_type
Data type: delivery_type
Required: no
This options allows the Merchant to exclude delivery types from the available delivery options. You can specify multiple delivery types by semicolon separating them. The standard delivery name cannot be excluded.

exclude_parcel_lockers
Data type: boolean
Required: no
This option allows to filter out pickup locations that are parcel lockers.

latitude
Data type: coordinates
Required: no
This provides the ability to display the postNL locations through the coordinates. If only latitude or longitude is passed as a parameter, it will be ignored and will simply use zip code for searching locations.

longitude
Data type: coordinates
Required: no
This provides the ability to display the postNL locations through the coordinates. If only latitude or longitude is passed as a parameter, it will be ignored and will simply use zip code for searching locations.

8.A.4 Examples

Get delivery options for 2132JE, 31 for PostNL

Get pickup options for 2132JE, 31 for PostNL

Get delivery options with a lot of options

Get pickup options for...

Edit this page
Last updated: 
Contributors Edie Lemoine