get delivery options
This block is part of the shipping group and was last modified in core v13.0.9.
get delivery options v13.0.9 This block is used to request the delivery options for a delivery.
- flow
flow - Connection required
postnlconnectionThe PostNL connection.
- Sender Address required
objectThe address of the sender of this shipment. Object should contain the following fields: city, country_code (ISO2), house_number, street, zip_code, house_number_ext.
- Receiver Address required
objectThe address of the receiver of this shipment. Object should contain the following fields: city, country_code (ISO2), house_number, street, zip_code, house_number_ext.
- Order Date required
dateThe order date used to request the delivery options.
- Preparing Duration (days) required
numberThe number of days it takes to send the shipment to PostNL (from your magazine). 1: same day, 2: next day, etc.
- Handle in holidays
conditionBoolean indicates if you handle orders in holidays. If false PostNL uses this to define delivery options.
- Days in future
numberHow much days you want to look in the future for delivery options can 1-9.
- Locations Quantity
numberHow much locations you want returned can be 1-3.
- Blocked Delivery Options
arrayBlocked delivery options that you want to block. Default every option is available, with this array you can remove options from that list. Check the documentation for the available options you can block.
- Cutoff options
arrayArray containing options for cutoff. For each day that has other cutoff settings make a object in the array with the day field (e.g. sunday) or you can set that field to all (so you can use that as default for all days). The object should also contain the following fields: cutoff_time (value HH:mm:ss), is_available (condition that indicates if you ship on that date) and type. See serivce documentation for the available types.
- flow
flow - Connection
postnlconnectionThe PostNL connection
- Success
conditionIf successful, return true.
- Delivery options
arrayThe delivery options for this delivery.
- Pickup options
arrayThe pickup options for this delivery.
- Error
valueError message if the delivery options could not be requested.
bezorging |
bezorgopties |
A typical wiring for get delivery options: a function trigger starts the flow; open connection feeds the connection pin; new object feeds the sender_address pin; new object feeds the receiver_address pin; date now feeds the order_date pin; number feeds the preparing_duration_days pin; the flow out pin feeds debug.
Version history
Introduced in v13.0.9.
Back to
shipping Return to the main group to view all sub-groups Back to PostNL Return to the group to view all blocks within this group