PostNord’s Delivery Options API
PostNord’s Delivery Options API provides easy-to-use delivery options for PostNord's products. Each delivery option provided by Delivery Options API will contain information needed to select the best option matching both the sending and receiving parties’ preferences. This information includes:
- When the recipient will receive the parcel - delivery time.
- Where the parcel will be delivered to, e.g. parcel locker or service point.
Order Handling
The delivery time that is provided by PostNord’s Delivery Options API is based, among other things, on the sender’s order handling process. Order handling can be different for each of the sender’s warehouses.
Prerequisites
To get a delivery time from PostNord, the sender needs to provide one of the following order handling fields (name within brackets is what the order handling corresponds to in PostNord’s Delivery Options API):
-
timeoflatestorder (timeOfLatestOrder): The latest time during the day that an order can be made for it to be shipped today. This field can be seen as a cut-off time or a stop time.
Suitable for: senders that have a single pickup per day.
-
handovertime (handOverTime): Time and date when the order will be handed over to PostNord. The sender must take their pick and pack time into account so that the order is guaranteed to be handed over to PostNord on the provided handOverTime.
Suitable for: senders that have multiple pickups per day and that can send the next pick-up time dynamically. It also allows the sender to specify a day and time 14 days in the future.
- readyforpickupdaysinterval (daysUntilOrderIsReady): If the sender is not able to be precise in their order handling process, daysUntilOrderIsReady can be used to provide a day span for how long it takes to handle the order before it is ready for pickup. daysUntilOrderIsReady is also suitable during periods with larger volumes such as Black Friday.
In the article Carrier ETA (estimated time of delivery) you can find examples of how to use Carrier ETA functions when writing the texts that will be shown in your Delivery Checkout. Note that the advanced conditions must be activated in the configuration you are working on.
In the GET /delivery-checkouts call, submit the order handling parameter with the value you want to use.
It is also possible to set up default values for all the available order handlings, this is done on the edit delivery checkout page, under the parameters section. Click on the arrow to the left of the parameter you want to set a default value for: timeoflatestorder, handovertime or readyforpickupdaysinterval (corresponding to daysuntilorderis ready), and you have the possibility to set the default values for this parameter below the table of parameters. Remember to press save to apply the default value.
Customer key
Customer key is a unique customer identifier that will be generated by nShift with the following format 'nshift-sendingCompanyName', where sendingCompanyName is the name of the Sender. This generic customer key is enough to be able to use the different order handlings available in the Delivery Options API.
Contact information
For general questions about the Delivery Options API, contact PostNord Customer Integration: kundintegration@postnord.com