Key concepts
Rule — condition in nShift Checkout that changes which return delivery options are shown, or what they cost
Parameter — a field from the return information that you add in nShift Checkout so rules can use it, such as returnType. Rules can only use fields that are added as parameters.
Before you begin
Make sure you have a shipping account with a linked nShift Checkout configuration. See Create a shipping account.
Return information sent to nShift Checkout
You can build rules on any of these values.
| Group | Field | Description | Example |
|---|---|---|---|
| order | currencyCode | Currency of the return | SEK |
| order | languageCode | Language of the return | sv |
| order | localeId | Locale of the return | sv-SE |
| order | totalVolumeCm3 | Total volume in cubic centimeters | 0 |
| order | totalWeightKg | Total weight in kilograms | 0 |
| order | totalPrice | Total price of the returned items | 0 |
| receiver* | name | Name of the receiver | Karin |
| receiver* | address1 | First address line | |
| receiver* | address2 | Second address line | |
| receiver* | postalCode | Postal code | |
| receiver* | city | City | |
| receiver* | state | State | |
| receiver* | country | Country | |
| receiver* | Email address | ||
| receiver* | phone | Phone number | |
| receiver* | mobile | Mobile number | |
| packages | weightKg | Package weight in kilograms | |
| packages | volumeCm3 | Package volume in cubic centimeters | |
| packages | dimensions — lengthCm | Package length in centimeters | 1 |
| packages | dimensions — widthCm | Package width in centimeters | 1 |
| packages | dimensions — heightCm | Package height in centimeters | 1 |
| packages | contents | Package contents | GOODS |
| variables | marketCode | Market in nShift Returns | market-SE |
| variables | outboundCarrier | Carrier used for the original delivery | POSTNORD |
| variables | outboundService | Service used for the original delivery | P19 |
| variables | size | Size of the returned item | S |
| variables | color | Color of the returned item | blue |
| variables | returnType | Type of return: RETURNS, CLAIMS, or EXCHANGES | CLAIMS |
Note Any other key-value pair sent under conditions through the API is also available to rules.
*Receiver is the consumer returning.
Offer free returns for claims
Add a rule that removes the fee from a delivery option when the return is a claim.
Steps
- In nShift Checkout, open the configuration linked to your shipping account
- Add a parameter with the type Field value and the data type String
- Enter returnType as the parameter name
- Go to Rules and select Add rule
- Set the condition to returnType equals CLAIMS
- Select the delivery option and set the fee to 0
- Select Save
Result
Customers making a claim see the delivery option with no fee. Other return types keep the regular fee.