Checkout Requirements | BG_064
Here, we'll take a look at configuring Checkout Requirements. This group of settings allows you to apply various configurations of rules which will prevent end users from proceeding to checkout under various scenarios. If any of the rules are not met when a user tries to check out, they will not be able to do so.
We'll look at an example of one simple configuration, where checkout can only occur if the basket quantity is between set values.
1. Navigate to Checkout Settings
2. Click on Configure under the Checkout Requirements section
3. Checkout Requirements screen
The checkout requirements screen is split into numerous sections where you can create rules for a number of different scenarios. Each section has a title, a description of its functionality and an "Add" button where you can create one or more rules within that section.
Available sections and their use cases consist of:
Shipping Fee | It will check the order shipping costs (without tax) if the value is above/below the threshold.
Product tag | It will check each line item if the line item has the product tag. The product tag can be found by id or name
Product Group | It will check each line item if it is part of the group. The product group can be found by id or name
Order Subtotal | It will check the order subtotal if the value is above/below the threshold. There are multiple scope to create a rule here: Customer, Department, Customer Role.
Customer Scope: This can be configured either globally or per customer rule. If a customer-specific rule is defined, it will override the global rule. Customers can be identified by id, username, or email/full name.
Customer Role Scope: can be found by id or name
Department Scope: can be found by id or name
Order Quantity | It will check the order quantity across all order lines if the value is above/below the threshold
Orderline Total | It will check the order line total (excl tax) value if is above/below the threshold.
Orderline Quantity | It will check each mapped order line quantity value individually if is above/below the threshold. It can be configured as global or per order line product rule. The defined order line product rule will override the global rule. The product can be found by name.
Checkout Attribute | It will check the value of the checkout attribute and if the regular expression matches. The checkout attribute can be found by id or name
Category | It will check each line item if it is in the category. The category can be found by id or name
4. As an example, we will focus on Order Quantity
We'll create a basic rule and see this in action on our front-end basket screen
5. Click on Add new item
6. Enter the required information (in this case an upper and lower threshold) and specify whether this should disallow checkout using the available checkbox
7. Click on Save
8. Your new rule will be created
Multiple rules can be created if required, both in the same section (so Order quantity in this case) or within different sections.
9. Remember to navigate to the top of the page and click on Save
10. It's a good idea to test your rules
We've implemented a debug mode for the Checkout Requirements. This allows you to use your browsers Console to review how any applied rules are being enacted. We'll see this in action later.
11. Navigate to your Storefront's front end
Add item(s) to your basket (cart) and navigate to the basket screen
12. If your Checkout Requirements have not been met, a message will be displayed customised to your rule
Whilst the Checkout button is still available, clicking on it will simply return you to the basket screen.
13. Use Debugging (if enabled) to check which of your rules are being trigger
Please note: These functions may differ slightly between browsers. I am using Google Chrome during the creation of this guide.
Right click anywhere on your browser and inspect the page.
Navigate to the console
Within the console, you will see written records detailing if any specified rule is preventing checkout, along with details of the requirements of those rules.
