Some parameters already exist in the system, but you can also add your own.
Parameters are configured in the GUI. 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, fromzipcode and fromcountry.
Go to:
- List of parameters
- Set default value for a parameter
- Create and add custom parameters
- Carrier specific parameters
List of parameters
The following parameters come with the system. Some parameters are mandatory for certain carriers. Please refer to the carrier for further information.
|
Parameter |
Type |
Description |
|
language |
Text |
Language code |
|
currency |
Text |
Currency code |
|
date |
Date |
Date Supplied as YYYY-MM-DD |
|
time |
Time |
Time Supplied as HH:MM |
|
fromcountry |
Text |
Sender country |
|
tocountry |
Text |
Receiver country |
|
fromzipcode |
Text |
Sender zip code |
|
tozipcode |
Text |
Receiver zip code |
|
tostreet |
Text |
Receiver address |
|
fromstreet |
Text |
Sender address |
|
tocity |
Text |
Receiver city |
|
fromcity |
Text |
Sender city |
|
fromstate |
Text |
Sender state |
|
tostate |
Text |
Receiver state |
|
tosms |
Text |
Receiver mobile phone number |
|
toemail |
Text |
Receiver email address |
|
todoorcode |
Text |
Receiver door code |
|
weight |
Decimal number |
Shipment weight Supplied as 0.0 |
|
minimumparcelweight |
Decimal number |
Minimum parcel weight for carriers' weight limits Supplied as 0.0 |
|
maximumparcelweight |
Decimal number |
Maximum parcel weight for carriers' weight limits Supplied as 0.0 |
|
cartprice |
Decimal number |
Total amount in the shopping cart Supplied as 0.0 |
|
outofstock |
Boolean |
The item is out of stock. |
|
readytopackdate |
Date |
Date when the item is ready to pack Supplied as YYYY-MM-DD |
|
uselatestlist |
Boolean |
Activate a condition list on uploading. |
|
width_cm |
Interger |
Parcel width |
|
length_cm |
Interger |
Parcel length |
|
height_cm |
Interger |
Parcel height |
|
pickupdate |
Date |
Pickup date |
|
pickuptimefrom |
Time |
Earliest pickup time |
|
pickuptimeto |
Time |
Latest pickup time |
|
timezonereceiver |
Text |
Receiver's time zone |
|
timezonesender |
Text |
Sender's time zone |
|
currentutcdatetime |
Date and time |
Timestamp for an order, for example, for valid price at a certain date and time |
|
filteragentidlist |
Text |
Filter for showing own agents Agent ID:s are separated by |. |
Set default value for a parameter
- Go to Maintenance > Delivery Checkout.
- When creating a new Delivery Checkout you add default values to parameters on the New delivery checkout page. To add default values to parameters on an existing Delivery Checkout, click the edit icon
to the left of the Delivery Checkout on the Delivery checkout page.
- Click
- The parameter appears in the field Name under the parameter list.
- Enter a value in the Default field using the Type defined for the parameter.
- Click Save.
Create and add custom parameters
You can add parameters to a new or existing Delivery Checkout.
- Go to Maintenance > Delivery checkout.
- When creating a new Delivery Checkout you create new parameters on the New delivery checkout page. To add new parameters to an existing Delivery Checkout, click the edit icon
- In the Parameters section you can enter name, type and default value.
- Click New parameter.
You delete the parameter by clicking the delete icon next to it.
Carrier specific parameters
For some carriers there are parameters that should only be used for their services.
|
Carrier |
Parameter |
Type |
Description |
|
helthjem/Svosj |
helthjem_active_subscription |
Boolean |
Gets set to true if there is an active Svosj-subscription with the recipient's email. |
|
helthjem/Svosj |
svosj_trial_eligible |
Boolean |
Gets set to true if the recipient is eligible for a 30-day free Svosj trial account. |
|
Instabox |
instaboxexp_recommendable |
Boolean |
Gets set to true if there is an Instabox locker closer than x meters from the zip code of the receiver (where "x" is a number configured by the merchant and Instabox). |