Sign in

nShift Help Center

Custom PUDO filtering

Avatar
Malene Tidemann
Updated

Custom PUDO (Pick-Up Drop-Off) points are your own locations, for example, physical stores. It is possible to create lists of PUDO points and make these available as delivery options in your Checkout configuration. Please contact nShift Customer Service, if you would like to upload a list of custom PUDO points. 

 

You can filter the list of displayed custom PUDO points dynamically using parameters and functions. A use case could be that you only want to display the stores that have the item in stock for express pick-up.

 

How to use filtering conditions

  1. Go to your Checkout configuration and click on Delivery options.

  2. Choose your Custom Pudo. Under the Carrier Service section, use the field Pickup point filter condition to define conditions to dynamically filter the displayed list in the widget. 

    pudo-filter.png

    You can use the PUDO-related functions as well as any other functions to build your condition.

 

System parameter: Filter_agent_id_list

There is a system parameter called filter_agent_id_list that you can use to pass in dynamically a reference to a condition list when fetching delivery options and use for custom PUDO filtering.

A condition list is a file where you can list a set of data such as PUDO IDs, zip codes, etc. You can upload multiple condition lists. (Read more about condition lists here).

filter-param.png


Tip: Define a default value to have a fallback value

 

filter-example.png


Note: The condition list (my_agent_list in the example above) must exist.



Functions related to PUDO points

Function Result Type Argument Type Result
pickupPointId Integer N/A The id of the pickup point
pickupPointName String N/A The name of the pickup point

pickupPointAddress1

 String N/A The address1 field value of the pickup point
pickupPointAddress2 String N/A The address2 field value of the pickup point
pickupPointPostalCode String N/A The postal code of the pickup point
pickupPointCity String N/A The city of the pickup point
pickupPointCountry String N/A The country of the pickup point
pickupPointState String N/A The state of the pickup point
pickupPointType String N/A The type is either “SERVICE_POINT” or “LOCKER”.
pickupPointCount String N/A The total number of pickup points selected by the filter so far.
pickupPointServicePointCount Integer N/A The number of pickup points of type SERVICE_POINT selected by the filter so far.
pickupPointLockerCount Integer N/A The number of pickup points of type LOCKER selected by the filter so far.

 

 

Related articles