API autorisation and authentication
To use the PostNL integration the following information is needed:
- Initial setup, you enter this information during onboarding:
- APIKey - how to get an api key
- CustomerCode (eg:
DEVC
)
- For every shipment: CustomerNumber (eg:
11223344
)
Barcodes
This integration is usig the PostNl All-In-One api which is generating the barcodes, creating the shipment and confirming the shipment in one request to PostNL.
Please note that for shipments outside of the EU a Global Pack code is required. This code can only be created by PostNl for existing customers that are already shpping parcels. Once the Global Pack code is created, it will be linked to the API key and from that point moment it is possible to ship outside the EU.
Service levels and service options
PostNL is using product codes to trigger the correct shipping product. Within this integration the original PostNL product codes are used as Service Level References as much as possible. Only for the Guaranteed products a product code suffix is added to indicated the time slot for that specific product.
Some PostNL product need to be triggered by using the serviceLevel reference in combination with other shipment properties like insuredvalue
or residentialDivery
. If this is the case, the trigger is added to the product table in the colum trigger
NL domestic
Product description | ServiceLevelReference |
---|---|
Standard shipment | 3085 |
Deliver to stated address only | 3385 |
Delivery to neighbour + Return when not home | 3090 |
Deliver to stated address only + Return when not home | 3390 |
Extra Cover | 3087 |
Extra cover + Return when not home | 3094 |
Signature on delivery + Deliver to stated address only | 3089 |
Signature on delivery + Deliver to stated address only + Return when not home | 3096 |
Signature on delivery | 3189 |
Signature on delivery + Return when not home | 3389 |
Mailbox parcel + Unsorted | 2928 |
Mailbox parcel + Sorted | 2929 |
Pickup + Signature on Delivery | 3533 |
Pickup + Extra Cover | 3534 |
Pickup + Signature on Delivery + Notification | 3543 |
Pickup + Extra Cover + Notification | 3544 |
Returns to a Business reply number | 2285 |
Single return label to home address | 3285 |
Belgium to NL
Product description | ServiceLevelReference |
---|---|
Standard shipment | 4090 |
Signature on delivery | 4091 |
Delivery to stated address only | 4093 |
Signature on delivery + Delivery to stated address only | 4094 |
Signature on delivery, Delivery to stated address only, Return when not home | 4096 |
Extra cover | 4097 |
Pickup at PostNL location, Signature on delivery | 4098 |
Belgium domestic
Product description | ServiceLevelReference |
---|---|
Belgium Deliver to stated address only | 4060 |
Belgium Delivery to neighbour | 4061 |
Belgium Signature on delivery + Deliver to stated address only | 4062 |
Belgium Signature on delivery | 4063 |
Belgium Extra cover (EUR 500) + Deliver to stated address only | 4065 |
NL to Belgium
Product description | ServiceLevelReference |
---|---|
Pick up at a PostNL location in Belgium | 4936 |
Deliver to stated address only | 4941 |
Belgium Standard delivery | 4946 |
Parcel Netherlands-Belgium + Signature upon delivery | 4912 |
Parcel Netherlands-Belgium + extra cover | 4914 |
B2B parcel Netherlands-Belgium | 4983 |
EU and non EU
Product description | ServiceLevelReference |
---|---|
Parcel EU - track&trace | 4907 |
Parcel EU - standard | 4999 |
Parcel Non EU Track & Trace | 4909 |
Guaranteed / Morning delivery (only NL)
To trigger the the Guaranteed / morning delivery a aditinal timeslot code needs to added to the ServiceLevel (eg. 3085_0900
). The following options are available.
- Delivery before 09:00 (add
_0900
to product code in the ServiceLevelReference) - Delivery before 10:00 (add
_1000
to product code in the ServiceLevelReference) - Delivery before 12:00 (add
_1200
to product code in the ServiceLevelReference) - Delivery before 17:00 (add
_1700
to product code in the ServiceLevelReference)
The following ServiceLevel allow a guaranteed service option to be added.
Product description | ServiceLevelReference |
---|---|
Standard shipment | 3085 |
Extra cover | 3087 |
Signature on delivery + Deliver to stated address only | 3089 |
Delivery to neighbour + Return when not home | 3090 |
Extra cover + Return when not home | 3094 |
Signature on delivery + Deliver to stated address only + Return when not home | 3096 |
Signature on delivery | 3189 |
Deliver to stated address only | 3385 |
Signature on delivery + Return when not home | 3389 |
Deliver to stated address only + Return when not home | 3390 |
Products not yet implemented
If you need to use one of the following products, please contact our support team.
- ID check (due to missing ID document type in Model)
- Registered letter labels
- Dangerous goods
- Pickup Service
- On Demand delivery
- Domestic-BE Pickup at PostNL location Belgium (because Downnetwork partner ID is required + Downnetwork pickup location code is required ) Productcode
4878
- NL to BE pickup at PostNL location Belgium (because Downnetwork partner ID is required + Downnetwork pickup location code is required ) Productcode
4880
- Extra @ Home
- International Pickup Points. Productcode
4907
(only PDF label response ) - International Business Reply Service (IBRS). Productcode
2484
(only PDF label response)
Returns
- Returns to a Business reply number (Antwoordnummer)
- Returns to a home address