A Checkout configuration has a number of parameters activated by default and the option to activate additional predefined parameters, as well as create custom parameters. Parameters can be used to set up conditions in the Rule Engine.
If a parameter is used in a condition and you do not set a default value, the parameter value must be set in the API call. Parameters connected to the sender are set automatically, for example, from_postal_code and from_country.
Go to:
Activate a parameter and set a default value
- Edit an existing Checkout or create a new Checkout.
- Go to Parameters in the menu on the left side.
- Click on the parameter you want to activate from the drop-down list. The parameter will now be added to the list of active parameters.
- Click on an active parameter.
- Enter a value in the Default value field using the Type defined for the parameter. (text, date, time, decimal number, boolean, integer).
- Click OK to save.
Create custom parameters
You can add custom parameters to a new or existing nShift Checkout configuration.
- Go to Parameters in the menu on the left side.
- Expand the drop-down list and choose Add customer parameter...
- Enter Name, Type, and Default value.
- Click OK to save.
List of parameters
| Parameter | Type | Description |
| cart_price | Decimal number | Total amount in the shopping cart Supplied as 0.0 |
| currency | Text | Currency code |
| current_utc_date_time | Date and time | Timestamp for an order, for example, for a valid price at a certain date and time. Supplied as YYYY-MM-DD-HH-MM |
| date | Date | Date Supplied as YYYY-MM-DD |
| delivery_time_utc_date_time | Date and time | Delivery date and time Supplied as YYYY-MM-DD-HH-MM |
| filter_agent_id_list | Text | Filter for showing own pickup locations. Agent IDs are separated by |. |
| from_city | Text | Sender city |
| from_country | Text | Sender country |
| from_postal_code | Text | Sender postal code |
| from_state | Text | Sender state |
| from_street | Text | Sender address |
| from_timezone | Text | Sender's time zone |
| height_cm | Interger | Parcel height |
| language | Text | Language code |
| length_cm | Interger | Parcel length |
| locale | Text | Location code, e.g. "en-GB" |
| maximum_parcel_weight | Decimal number | Maximum parcel weight for carriers' weight limits. Supplied as 0.0 |
| minimum_parcel_weight | Decimal number | Minimum parcel weight for carriers' weight limits. Supplied as 0.0 |
| out_of_stock | Boolean | The item is out of stock. |
| pickup_date | Date | Pickup date |
| pickup_time_from | Time | Earliest pickup time |
| pickup_time_to | Time | Latest pickup time |
| random_seed | Text | The submitted value determines which Checkout is randomly selected in an experiment. As long as it stays the same, the same checkout will be chosen across sessions, effectively locking a customer to one checkout without revealing which one. |
| ready_to_pack_date | Date | Date when the item is ready to pack. Supplied as YYYY-MM-DD |
| return_from_city | Text | Return sender city |
| return_from_country | Text | Return sender country |
| return_from_current_date | Date | Earliest return date Supplied as YYYY-MM-DD |
| return_from_current_date_time | Date and time | Earliest return date and time. Supplied as YYYY-MM-DD-HH-MM |
| return_from_current_time | Time | Earliest return time Supplied as HH:MM |
| return_from_current_weekday | Text | Earliest return weekday |
| return_from_current_weekday_number | Integer | Earliest return weekday number |
| return_from_postal_code | Text | Return sender postal code |
| return_from_state | Text | Return sender state |
| return_from_street | Text | Return sender address |
| return_to_city | Text | Return receiver city |
| return_to_country | Text | Return receiver country |
| return_to_current_date | Date | Return latest date |
| return_to_current_date_time | Date and time | Return latest current date and time |
| return_to_current_weekday | Text | Return latest weekday |
| return_to_current_weekday_number | Integer | Return latest weekday number |
| return_to_postal_code | Text | Return receiver postal code |
| return_to_state | Text | Return receiver state |
| return_to_street | Text | Return receiver street |
| time | Time | Time Supplied as HH:MM |
| to_city | Text | Receiver city |
| to_country | Text | Receiver country |
| to_door_code | Text | Receiver door code |
| to_email | Text | Receiver email address |
| to_latitude | Text | Receiver latitude |
| to_longtitude | Text | Receiver longtitude |
| to_postal_code | Text | Receiver postal code |
| to_sms | Text | Receiver mobile phone number |
| to_state | Text | Receiver state |
| to_street | Text | Receiver address |
| to_timezone | Text | Receiver's time zone |
| use_latest_list | Boolean | Activate a condition list upon uploading |
| volume_cm3 | Decimal number | Parcel volume |
| weight_kg | Decimal number | Shipment weight Supplied as 0.0 |
| width_cm | Interger | Parcel width |