Skip to main content

Earning rules

Earning rules define how customers can earn points.

To create a new earning rule, go to Marketing -> Promotions -> Reward Points -> Earning Rules and press Add New.

The process of editing an earning rule page is complex and varies depending on the rule type, so each type has its own subsection:

If you wish to create a custom earning rule, please refer to the Custom behavior rules section of this manual.

General information​

The following options apply to all types of earning rules:

  • Rule name: the internal name of the rule. This is used for internal purposes only.
  • Display name: the rule name displayed in the customer's account, providing valuable information about how customers can earn points.
  • Type: this defines the type of rule. The following types are available:
    • Behaviour rule: points earned based on specific actions taken by customers (e.g., writing a review, signing up, etc.).
    • Cart rule: points earned based on the total amount in the customer’s cart or its contents.
  • Is active: the status of the rule. You can activate or deactivate the rule without deleting it.
  • Active from, Active to: the date range during which the rule is active.
  • Websites: select which websites this rule applies to if you are running a multi-store setup.
  • Customer groups: choose the customer groups to which the rule applies. You can select multiple groups (e.g., General, Wholesale, VIP).
  • Stop further rules processing: this setting allows you to stop other rules from being applied if this rule is triggered. This is particularly useful when rules overlap, or you want to ensure a specific rule takes precedence. See the important note below for details.
  • Is shown on the product page: displays the rule on the product page. This option can only be activated for Cart Rules.
  • Priority: set the processing order of rules when multiple rules are applicable. Rules with a lower priority value are processed first.
Note

Important: Different rules can apply to similar conditions or the same event but with some differences, requiring only one rule per order. The Priority and Stop further rules processing options help manage their execution order.

Example

You have two rules: one for regular customers and one for VIP customers. Based on conditions, both rules can be applied for a VIP customer simultaneously, but you want only the VIP rule to be applied.

In this case, for the VIP rule, set a higher priority and enable the "Stop Further Rules Processing" option. This way, when a VIP customer makes a purchase, the VIP rule will apply first due to its higher priority. Since the "Stop Further Rules Processing" option is enabled, other rules with lower priority will not be applied.

Each rule has four possible global modes for applying its conditions in the Conditions tab, shown with the header:

If *[apply mode]* of these conditions are *[validation mode]*

Applying modes define when the rule can be triggered:

  • ALL: the rule is executed only when all the conditions are met.
  • ANY: the rule is executed when one or more conditions are met.

Validation modes define the result produced by each condition:

  • TRUE: the conditions are valid.
  • FALSE: the conditions are invalid.

These modes create a flexible set of conditions to satisfy policies of any complexity.

Cart rules​

Award points based on the total amount of actual money spent in the cart. This rule is recommended for use with tier or special prices (including taxes, depending on the shipping country, for example), which can dynamically alter the actual price of a product.

Conditions​

Cart rules have a more complex condition subsystem:

  • Product attribute combination - This allows you to set product attribute combinations. The attributes list is the same as in the Product Rule. It has the following scheme:

If an item is [validation mode] in the cart with [applying mode], and any of these conditions are true:

  • Validation mode can be either FOUND or NOT FOUND, determining whether a checked product exists in the cart or not.
  • Applying mode can be either ALL or ANY, which function the same as in the previous rule type.
  • In addition to product properties, this mode provides three additional properties regarding cart content:
    • Price in cart: allows checking the products that match prices in the cart.
    • Quantity in cart: allows checking the number of products ordered in the cart.
    • Row total in cart: the total cost of the products that match the conditions in the cart. Calculated by multiplying the two properties above.
  • Product subselection: allows checking the cart item attributes. The scheme is:

If [selection mode] for a subselection of items in the cart matches [applying mode] of these conditions

  • Selection mode: defines which primary parameter is checked - product quantity (total quantity) or its row total (total amount).
  • Applying mode: functions as in previous rule types.
  • Conditions combination: allows breaking the rule into logical parts, each validated separately. The scheme is:

If *[apply mode]* of these conditions are *[validation mode]*

Useful for the ANY applying mode and complex conditions. It creates a nested block as described in the General section.

  • Cart attribute: allows reward points based on cart attributes:

    • Additional payment method: applies condition with an additional payment method.
    • Subtotal: the cart subtotal, including shipping and handling fees. It may include a discount if Stores -> Configuration -> Sales -> Tax -> Calculation Settings -> Apply Customer Tax is set to Before discount.
    • Total items quantity: total quantity of items in the current cart.
    • Total weight: total weight of products in the cart.
    • Payment method: the selected payment method.
      Note

      If the payment method is not selected, this condition will return false. Therefore, this condition only applies to checkouts or when payment selection is available directly from the cart.

    • Shipping method: the selected shipping method. The note above applies here.
    • Shipping Postcode: the postal code where the products will be sent. The note above also applies here.
    • Shipping Region: the shipping region. The note above also applies here.
    • Shipping State/Province: the state or province where the product will be delivered. The note above also applies here.
    • Shipping Country: the country where the product will be delivered. The note above also applies here.
    • Is rewards points used: applies the condition when reward points are used.
    • Coupon used: applies the condition when a coupon is used.
    • Coupon code: the identification code of the used coupon.

  • Customer: allows reward points based on customer information:

    • Is referee: the customer is the referee.
    • Is referral: the customer is the referral.
    • Email: the customer’s email.
    • Group: the group to which the customer belongs.
    • Lifetime sales: the customer's total sales.
    • Lifetime spent points: the customer's total spent points.
    • Number of orders: the customer's total number of orders.
    • Is subscriber of newsletter: the customer is subscribed to the newsletter.
    • Number of reviews: the customer's total number of reviews.
    • Number of referred friends signups: the customer's total number of signed-up referrals.
    • Number of referred friends orders: the total number of orders made by the customer's referrals.
    • Sum of referred friends orders: the total value of orders made by the customer's referrals.
    • Number of referrals who ordered at least once: the total number of the customer’s referrals who have ordered at least once.

Actions​

Apply the rule only to cart items matching the conditions. This acts as a shortcut for conditions in Product attribute combination mode.

Notification​

  • Message: displays a notification on the product pages if the rule is applied to the current product.

Tiers​

  • Customer earning style: the strategy used in calculating points.
    • Give X points to customer: the customer is awarded a fixed number of points.
    • Give X points for every spent Y: points are calculated based on the cart subtotal.
    • Give X points for every Z quantity: points are calculated based on the total quantity of items in the cart.
  • Number of points (X): the number of points awarded at each step.
  • Step (Y): used with Give X points for every spent Y, this defines the size of the chunk into which the subtotal is divided.
  • Quantity step (Z): used with Give X points for every Z quantity. If not empty, the item quantity will be divided into chunks of this size, and points calculated accordingly.
  • Earn maximum: the maximum number of points earned from the current rule.
tip

For example, you can create the following cart rules in your store:

  • Buy 3 products in one order and get 100 points.
  • For every $1 spent, you will receive 1 point.
  • For every product ordered, you will receive 100 points.

Behaviour rules​

These rules are triggered by specific customer actions, such as writing a review, signing up for an account, or placing an order. Unlike cart rules, which often require complex conditions, behaviour rules typically award a fixed number of points and are easier to configure.

Conditions​

When setting up behaviour rules, the following settings are commonly available:

  • Event: the specific action that triggers the reward. Examples include:
    • Customer signs up in store: award points when a customer signs up in the store. Useful for awarding points that should be used in the very first order.
    • Customer places order: triggered when the customer places an order, and it is completed (e.g., invoiced and shipped).
    • Customer refers a friend: award points when the customer sends an invite to a friend.
    • Customer writes a product review: award points when the customer adds a review, and it is approved by staff.
    • Customer has a birthday: this rule is executed by a cron task, which starts at 00:00 each day for every customer. If the customer has a birthday, the rule will be executed at that time.
    • Customer is not active for a long time: set the number of days to determine inactivity. This rule is also executed at 00:00 by a cron task.
      Note

      For the events Customer has a birthday and Customer is not active for a long time (executed by cron), you can only use the Give X points to customer style.

    • Customer creates RMA: creates a return merchandise authorization.
    • Newsletter sign up: award points when a customer signs up for the newsletter.
    • Twitter Tweet: award points when a customer tweets a product page on Twitter.
    • Pinterest Pin: award points when a customer pins a product on Pinterest.
    • Facebook share: award points when a customer shares the product on Facebook.
    • Customer joins the affiliate program: award points when a customer joins an affiliate program (Mirasvit Affiliate).
    • Customer tier up: award points when a customer's tier level increases.
    • Customer tier down: deduct points when a customer's tier level decreases.
    • Push Notifications sign up: award points when a customer opts to receive push notifications.
    • Referred customer signs up in the store: award points when a referred customer (referee) signs up in the store. For more information, refer to the Building Referral Program section.
    • Order from a referred customer: award points when a referred customer places an order, and it is complete. For more information, refer to the Building Referral Program section.
    • Custom events: a list of custom events created using Custom Behavior Events.
Note

For further customization of behaviour rules, consider using the Custom behaviour rules section of this guide.

There's also a subsection Apply the Rule only if the following conditions are met, where additional conditions can be set. Here is the list of currently supported properties:

  • Customer: conditions based on the customer’s information.
    • Is Referral: checks whether the customer has invited other customers to the store, and if they have become registered customers. This is extremely useful for building a Referral Program for the customer.
    • Is Referee: checks whether a customer is a referee (i.e., whether someone invited them).
    • Email: checks the customer's email.
    • Group: checks the group a customer belongs to.
    • Lifetime sales: calculates the total amount purchased by the current customer and compares it with the specified value.
    • Lifetime spent points: calculates the total points used by the current customer and compares it with the specified value.
    • Number of Orders: calculates the total number of orders placed by the current customer and compares it to the specified value.
    • Is subscriber of Newsletter: checks whether the customer has subscribed to the newsletter.
    • Number of Reviews: calculates the total number of approved reviews made by the current customer and compares it to the specified value.
    • Number of referred friends signups: calculates how many invited customers became registered customers (e.g., referees).
    • Number of referred friends orders: the total number of orders placed by the referees invited by the current customer.
    • Sum of referred friends orders: the total value of orders placed by all referees invited by the current customer.
    • Number of referrals who ordered at least once: the number of referees invited by the current customer who have placed at least one order.
  • Referred Customer: this condition group includes rules related to the referred customer (the customer who was referred by the existing customer).
    • Is Referral: checks whether the referred customer referred another customer.
    • Referred: Group: checks the referred customer's group.
    • Referred: Lifetime Sales: checks the total value of purchases made by the referred customer.
    • Referred: Number of Orders: checks the total number of orders placed by the referred customer.
    • Referred: Is subscriber of newsletter: checks whether the referred customer is subscribed to the store’s newsletter.
    • Referred: Number of reviews: checks how many product reviews the referred customer has written.
  • Order: conditions based on the customer’s order.
    • Subtotal: subtotal of the cart, including shipping and handling fees.

Notification​

  • Message in the rewards history: A description of rewards earned from previous transactions.
  • Message for customer email: A notification sent to the customer via email, added to the Balance Update Email template.

Tiers​

Define how points are awarded in behaviour rules:

  • Customer earning style:
    • Give X points to customer
    • Give X points for every Y spent
    • Give X points for every Z quantity
  • Number of points (X): the number of points awarded.
  • Maximum number of points per day: set a daily limit for points. Leave empty to disable the limit.
  • Assign customer to group: automatically move the customer to a different group when the rule is triggered.
Example of rules
  • Write a review and earn 50 points: customers earn 50 points for writing a product review.
  • Create an account and earn 100 points: new customers are rewarded with 100 points upon signing up.
  • Place your first order and earn 200 points: reward customers for placing their first order by giving them 200 points.
  • Subscribe to the newsletter and earn 30 points: encourage customers to subscribe to your newsletter by offering 30 points.

For more examples, see the Earning rules examples section.