Checkout messages are used to display messages to the user when they are checking out. Some examples of checkout messages are:
- Certain rules and regulations to be taken into account when purchasing certain products, ie hazardous substance warnings;
- Changes to orders over holiday periods;
- Expected shipping delays on certain products.
When a checkout message is displayed, there is is an option for a confirmation box to be added so that the user must acknowledge the message before continuing.
Checkout messages are shown to all users at the checkout stage but they can be configured so that the message is only shown when certain criteria is met.
Some examples of criteria that can be set up to limit when a checkout message is shown:
- Orders with products from a specific category;
- Specific customers;
- Orders containing specific products;
- Orders over/under/between certain dollar values.
Step-by-step guide
To Create a Checkout Message:
- Login as an Administrator.
- Navigate to 'Settings' --> 'Checkout Message' (CheckoutMessageMaint.aspx).
- Click 'New'.
- Enter the 'Sort Code/Mask' to define a product category. Enter a sort code for one group of products, '%' for ALL products, or leave blank if using an 'Override Query'.
- Set the value for 'Is Plain Text?':
- Ticked - The message is plain text and will be displayed as is.
- Unticked - The message is HTML and will be displayed as rendered HTML code, with formatting, etc.
- Set the value for 'Requires User Confirmation':
- Ticked - Displays a checkbox that the user must enable before being allowed to continue
- Unticked - Message is displayed, user does not need to enable to continue
- Enter an 'Override Query' if required (see examples below).
- Set the value for 'Applies to Mode' to indicate whether the message applies to B2B, B2C or both user roles.
- Select the 'Top Template' if applicable
- Select the 'Field Group Name' if applicable
- Select the 'Bottom Template' if applicable
Click 'OK' to save changes.
Setting | Description |
|---|---|
Sort Code/Mask | The sort code or category code. Can also use wild cards for multiple categories , i.e. SX123% |
Message | The message that is displayed to the user, this can be written in plain text or alternatively writing using HTML Code. |
Is Plain text? | Used to identify whether the message is displayed as plain text or HTML Code which will be rendered to the user. |
Requires User Confirmation | Used to include a checkbox for the user to select before they can continue. |
Override Query | Used to define alternative criteria to be met before the message is displayed to the user. An example would be: product.conditioncode = 'T' |
Applies To Mode | Used to specify whether the message is displayed to B2B users, B2C users or both. |
Top Template | The template that is displayed above the message. |
Field Group Name | The fieldgroup that is defined on the prontosalesorder table to be displayed along with the message. |
Bottom Template | The template that is displayed below the message. |
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
Related articles
