Rules

Getting started

From this article, you will learn about promotion module rules. Rules are whole promotions that contain in themselves conditions and actions and make them work together in selected altshops and date ranges. They are essential parts for a promotion to work.

  RememberYou can learn about the promotion module in the Promotion module introduction article.

To open the Rules / list view, in the admin panel, navigate to:

Promotions > Rules / list.

In the Rules / list view, we can find two tabs: Filters (1) and Rules / list (2)

Visualization of the rules / list module in the administrator panel

Table of contents:

1. Filters section
2. Rules list section
3. Adding a new rule

Filters section

The Filters section allows sorting of the rules in the promotion module, based on the available filters. Below you will find a description of each filter.

Visualization of the filters tab in the rules / list

• Is active? -  Defines the activity date of the visible list of rules. By default, "Yes" is selected.
• Alt shop - Defines to which alt shop, you want to limit the list of rules.

After defining the above filters, select the Apply Filters button to get a list of rules according to the applied filters.  

Rules list section

The Rules list section allows organizing the filtered rules, as well as editing, duplicating, and deleting the desired rules.

Below you will find a description of all possible actions you can perform in the rules list section.

Visualization of the Rules / list tab in the Rules / list.

•  Select the Show X entries(1) field to set the number of rules, displayed on one page (min 10 / max 100).
• The names of the columns (2) that contain information about target rules. Each column is susceptible to sorting. To sort the records, click on the title of the column in question.
  
  • ID - Internal ID of the rule.
  • Name - Name of the rule.
  • Start / end date - Range of dates where the rule is active.
  • Is active? - Activity status of the rule.
  • Sort order - Sort order of the rule. Sort order defines the order in which the rules will be applied in the customer cart, starting from 1.
  • Actions - List of buttons with possible actions that can be done to the desired rule:
    
    • Edit - Edit desired rule. Editing has exactly the same actions as adding a new rule, so the list of actions can be looked up in Adding a new rule chapter.
    • Duplicate - Duplicates the rules with all their properties and content. By default, duplicates are inactive.
    • View - Allows to view the content of the rule without the ability to edit any fields in it.
    • Delete - Deletes the rule without the ability to restore it
• Select the Deactivate expired rules button (3) to set the is active? status on all the rules that have start / end date range outside the current date.
• Select the Add list (4) button to go to the adding the rule. You can learn how to add a rule in the Adding a new rule chapter.
• Search box (5) where you can search for desired rule by its name.
• Page buttons (6), which allows user to change the page of currently viewed rules.

Adding a new rule

Add button allows users to create a new promotion rule, which can be configured to very specific needs.

Below, you will find a description of all possible actions you can perform while creating a new rule.

Visualization of the adding of the new rule.

• Name - Internal name of the promotion rule.
• Rule code - Value that is visible in the API. This value doesn't change anything, how the selected rule works on the website.
• JOY club member discount percentage - Value sent to JOY at the order line level. This value doesn't change anything, how the selected rule works on the website.
• Description - Description of the promotion rule. This field is visible to the customer if the action "Show description" is assigned to the rule.
• Rule type -  Type of the rule. There are two types to choose from:
  
  • Standard - standard rule type that doesn't make any specific changes. This is the default type that should be used in most cases.
  • ETD - is used for backward analytics of ETD (End of ticket discount) discounts and how many of them were added. Selecting this type requires JOY club member discount percentage to be filled.
• Start / end date -  Range of dates where the rule is active.
• Is active? - Activity status of the rule.
• Sort order - Sort order of the rule. Sort order defines the order in which the rules will be applied in the customer cart, starting from 1.
• Altshops - List of altshops where the rule will be active. You can assign the altshop by selecting them from the list on the left side, and pressing the arrow buttons. The double arrow button will move all the altshops
• Conditions - In the conditions field you can assign created conditions to the rule, assign operators to them, and the values. It is possible to change the order of the conditions using the arrows on the left side of the condition. Additionally, you are able to create a new condition from this window using the "Create new condition" button (1) and edit existing, selected conditions using the "Edit" button (2) next to the desired condition.
  At the bottom of the conditions list you will find brackets and logic connectors. They can be used to create more complicated promotions
  
  • Brackets - Brackets can be used with logic connectors to separate certain conditions, and run them together. For example, conditions can look like: X or {Z and Y}, where X condition will run the promotion OR combination of Z AND Y.
  • Logic connectors - Logic connectors allow you to create complicated promotions where multiple conditions must be fulfilled by using AND connector, or to select that the rule will be activated by multiple, independent conditions using the OR connector.
• Actions -  In the actions field, you can select multiple actions from the list of available ones. Actions will run, whenever selected conditions are met. You are additionally able to create a new action from this window using the "Create new action" button (3) and edit existing, selected action using the "Edit" button (4) next to the desired action.

  RememberYou can learn about promotion conditions in the Conditions article.

  RememberYou can learn about promotion actions in the Actions article.

In the example below, you can see a promotion with:

• Conditions that need to be fulfilled: Order value (catalog price) more or equal 50 euro OR
  { Discount code in basket = CODE AND Order items count more or equal 2 }.
• If the conditions are met, the customer will receive 50 euro discount on the most expensive product and 25% discount on the cheapest one.