Overview
Checkout messages are displayed to the user when they are finalising their order. For instance, they can be used to communicate:
Note - There is an option to add a confirmation box in the checkout message. If this is enabled, the user must acknowledge the message to continue with Checkout.
Checkout messages can be shown to all users at the checkout stage but a message can be configured so that it is shown only when certain criteria are met. For example, you can set messages for:
- orders with products from a specific category;
- specific customers;
- orders containing specific products;
- orders over/under/between certain dollar values.
Note - if two or more set messages are applicable to an order, both messages will appear in the checkout message box.
Step-by-step guide
1. Create a Checkout Message
- In the CMS, navigate to Settings → Checkout Messages.
- Click New.
- In Message, enter the message to be displayed to the user.
- Use Sort Code/Mask to define a product category:
- enter the sort code for one category of products,
- enter '%' for ALL products in all categories,
- wildcards for multiple categories, i.e., 'SX123%' or
- leave blank if using an 'Override Query'.
- For Is Plain Text?:
- Tick for the message to be displayed in plain text with no applied formatting.
- Untick for the message to be displayed by HTML formatting and site styles, etc.
- For Requires User Confirmation:
- Tick to display a checkbox that the user must tick before being allowed to continue
- Untick for the message to display without confirmation from the user
Enter an 'Override Query' if required. Note - This field works together with Sort Code/Mask. See Defining the criteria for checkout messages below.
An override query is used to define alternative criteria to be met before the message is displayed to the user.
The following tables can be used:
ProntoSalesOrder
ProntoSalesOrderLine
Customer
ProductAn example would be:
product.conditioncode = 'T'
See more examples below.
- For Applies to Mode, set whether the message applies to B2B, B2C or both user roles.
- (For classic sites only. Leave blank for BPD sites.) For the Top Template (displayed below the message), select the required template, if applicable.
- (For Pronto only.) For Field Group Name, select the fieldgroup that is defined on the prontosalesorder table to be displayed along with the message.
- (For classic sites only. Leave blank for BPD sites.) For the Bottom Template (displayed below the message), select the required template, if applicable.
To save these changes, click OK.
Defining the criteria for displaying checkout messages
When setting up a checkout message, the 'Sort Code/Mask' and 'Override Query' fields are used to define the criteria for whether or not a checkout message is displayed to the user. The following values will provide an example of how to display a checkout message for various scenarios.
Checkout Message Examples
You might find these scenarios helpful when creating your own Checkout Messages.
When a Product in a specific Category is in the Cart:
- 'Sort Code/Mask': Enter the Category code. i.e. SX123456
- 'Override Query': Leave blank.
When a Product under a higher level Category is in the Cart:
- 'Sort Code/Mask': Enter the Parent Category code and add a percentage sign to indicate any categories under that tree. i.e. SX12%
- 'Override Query': Leave blank.
For a specific Customer:
- 'Sort Code/Mask': Leave blank.
'Override Query': Enter the following query and substitute ABC123 for the customer code.
Code = 'ABC123'
When a specific Product is in the Cart:
- 'Sort Code/Mask': Leave blank.
'Override Query': Enter the following query and substitute AB-12345 for the product code.
productcode = 'AB-12345'
When one (or more) of several Product is in the Cart:
- 'Sort Code/Mask': Leave blank.
'Override Query': Enter the following query and substitute 'CV120','CV200','CV250' with your own product codes (comma-separated)
productcode in ('CV120','CV200','CV250')
When the Cart Amount is greater than $200.00 Ex Tax:
- 'Sort Code/Mask': Leave blank.
'Override Query': Enter the following query.
(soOrderTotalAmount-SoOrderTotalTax) > 200
2. Enable Checkout Message
Displaying the Checkout Message is enabled by adding the Checkout Messages widget in the relevant template, e.g., Cart. Further display options are also available in the widget. See the help page for the Checkout Messages widget.
Additional Information
--
| Minimum Version Requirements |
|
|---|---|
| Prerequisites |
|
| Self Configurable |
|
| Business Function |
|
| BPD Only? |
|
| B2B/B2C/Both |
|
| Ballpark Hours From CV (if opting for CV to complete self config component) |
|
| Ballpark Hours From CV (in addition to any self config required) |
|
| Third Party Costs |
|
| CMS Category |
|
Related help
