PostNL icon

PostNL

Interact with PostNL API

Actions17

Overview

This node interacts with the PostNL API to retrieve available delivery timeframes for a specified address and date range. It is useful in logistics, e-commerce, or shipping workflows where you need to determine when deliveries can be scheduled based on location and delivery options.

Typical use cases include:

  • Checking delivery availability before confirming an order.
  • Offering customers selectable delivery windows.
  • Planning shipments by understanding possible delivery dates.

For example, an online store could use this node to fetch delivery timeframes for a customer's address between two dates, considering if Sunday sorting is allowed, and then present these options during checkout.

Properties

Name Meaning
Allow Sunday Sorting Whether Sunday sorting is allowed, which enables delivery on Monday (true or false).
Start Date The start date of the timeframe to check, formatted as dd-MM-yyyy.
End Date The end date of the timeframe to check, formatted as dd-MM-yyyy. Must not be before the Start Date.
Country Code ISO2 country code of the delivery address. Options: NL, BE.
Postal Code Zipcode of the delivery address.
House Number House number of the delivery address.
House Nr Ext Optional house number extension of the delivery address (e.g., apartment or unit identifier).
City Optional city name of the delivery address.
Street Optional street name of the delivery address.
Options Delivery options for which expected timeframes should be calculated. At least one must be specified. Multiple values are comma-separated. Example options include "Daytime", "Evening", "Sunday".

Output

The node outputs JSON data containing the available delivery timeframes returned by the PostNL API for the given parameters. This typically includes details such as dates and timeslots when delivery is possible according to the requested options.

If the API supports binary data (not indicated here), it would be summarized accordingly, but this node primarily returns structured JSON data about delivery windows.

Dependencies

  • Requires an API key credential for authenticating with the PostNL API.
  • The node uses the PostNL API base URL configured via credentials/environment variables.
  • No additional external dependencies beyond the PostNL API and its authentication.

Troubleshooting

  • Invalid Date Format: Ensure Start Date and End Date follow the dd-MM-yyyy format. Incorrect formats may cause API errors.
  • End Date Before Start Date: The End Date must not be earlier than the Start Date. Validate input to avoid errors.
  • Missing Required Fields: All required fields (Allow Sunday Sorting, Start Date, End Date, Country Code, Postal Code, House Number, Options) must be provided.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Unsupported Country Codes: Only NL and BE are supported country codes; using others will likely result in errors.
  • Empty or Invalid Options: At least one valid delivery option must be specified in the Options property.

Links and References

Discussion