How To


How can I make customer earn points from buying specific products

It can be done in two ways - using Product or Cart rules.

If you use Product rule:

  • Jump to Conditions & Actions tab, and add one (or several) conditions as follows:
    • If you need to restrict earning to some product Categories, use Category condition from Product Attributes subsection in drop-down list;
    • If you need to restrict earning to some particular product, use SKU condition from the same subsection;
  • If you need to filter more than one product or category, then use one of following approaches:
    • Change ALL to ANY at master condition If ALL of these conditions are TRUE (this will make rule trigger, when at least one condition applies), and create a number of conditions for each category or product SKU;
    • Place to the condition comma-separated list of values, and select operator is one of instead of is.

If you use Cart rule:

  • If you need to control not only products, but also their quantity:
    • Jump to Conditions tab and add a new condition. In drop-down list select Product subselection. It will produce nested conditions block with a master condition, which filters quantity of products selected;
    • In this nested block set up quantity, that should trigger the rule. If you need to award customer for buying 3 items of some product - then nested block master condition should contain If total quantity equals or greater than 3 for a subselection of items in cart matching ALL of these conditions;
    • Add to this nested block Category, SKU, or other attributes of products, that should trigger the rule - like described for Product rule;
  • If you need just to control product presence in the Cart:
    • Jump to Actions tab, and create a new condition in Apply the rule only to cart items matching the following conditions section;
    • Add appropriate product attributes, that should trigger the rule - as described above.

Note: If you use Cart rule, do not use simultaneously both of described approaches - they will conflict. Create instead two Earning rules - you may also see next case to properly trigger them;


How can I prevent rules from multiply? For example: if there's two rules for products, and customer added to cart both - but only one rule should trigger.

  • Jump to General Information tab and assign to these rules priorities according to product's promotional significance. Say, you have products A and B, and if they both in cart - reward for B should be applied. Rule for product A thus should have priority 20, and for A - 10;
  • Set option Stop further rules processing to Yes. This will prevent rules with same or lower priority from triggering, even if their conditions apply.

How can I set up trading standard Magento coupons for additional points

  • Create an Earning Rule at Reward Points -> Earning rules, of Cart type;
  • Jump to the Conditions tab, and make new condition. In drop-down list, in section Additional Cart Attributes find Coupon Code condition and make it equal to coupon code, that should be traded for points;
  • Proceed to Actions tab, set Customer Earning Style to Give X points to customer, and in field Number of Points (X) set appropriate quantity reward points, that should be awarded on coupon application;
  • Activate the rule (and set activity period, if need).

Note: if you have coupons generated by some algorithm, Coupon Code condition also supports different operations - such as substring detection (contains operator) and check for one of coupon array (is one of operator), so it can be flexibly fitted to your coupon policy.


How can I set up rule to award both referral customer, and it's referee (e. q. customer, who invited him).

It can not be done via one earning rule, you will need two of them - one for Referral, and the second for Referee.

Rule for Referral can be created this way:

  • Create a new Earning Rule of any type at Reward Points -> Spending Rule;
  • Jump to the Conditions (or Conditions and Actions) tab, and add new condition. In drop-down list, in Customer section select Is Referral condition and set it to Yes;
  • Add other conditions - for example, if you need to set awards for certain order number, refer to milestone rule case, below in this section;
  • Jump to Actions section, set points to earn, save and activate rule.

Rule for Referee can be created only using Behaviour type of Earning Rule:

  • Create a new Earning Rule of Behaviour type at Reward Points -> Spending Rule, and jump to the Conditions and Actions tab;
  • If you wish to award customer, when referral registers, pick event Referred customer signs up in store;
  • If you wish to award customer, when referral places an order, pick event Order from referred customer;
  • If you also need to award referee for a certain number of order, placed by referral - or make other limitations regarding referral - use conditions from Referral Customer subsection. For example, if you need to award points only for first referral's order, you need Referral: Number of Orders condition;
  • Save and activate rule.

How can I create so-called 'threshold' and 'milestone rule', which will award customer with additional points on reaching sales amount or certain orders number

To award customers with additional points depending of their achievements, you need to use either Cart, or Behaviour rule. Both of them support conditions, that allows checking of customer's properties. Simply add them to the Conditions tab to make rule threshold or milestone.

Here is the list of conditions, that can be used for the most cases:

  • Award only with first order. Use condition - Number of Orders - and set it to 0. It does not applies only to Behaviour rules, which use Customer places an order event - in this case you need to set 1 (because this event triggers after order is placed);
  • Award customer for certain X-th order (say, 10-th). Use the same Number of Orders condition, but it shall be equal to X - 1 (for Customer places an order shall be equal to X);
  • Award customer for reaching certain X points on his balance. Use two conditions Balance points amount - for lower limit, and upper limit (if applies).
  • Award customer for spending X money in store. Use two conditions Lifetime Sales - for lower limit, and upper limit (if applies).

Not only customer overall achievements can be checked, but particular purchase as well. Use for that additional conditions, located under Cart Attributes, for rules of Cart type.


How can I award customer with 'gift' points, that he can use on his first order.

Customer can receive points immediately after registration using only Behaviour rule. Here is how it can be done:

  • Create a Behaviour rule at Reward Points -> Earning points and on Conditions & Actions pick up event Customer signs up in store;
  • Set Customer Earning Style to Give X points to customer, and set points amount to receive;
  • If you wish to suppress frontend notification for this rule, add Signing up event at Reward Points -> Settings -> Display -> Disable Behaviour Notifications;
  • Add other conditions, if you need to - for example, a check for Referral (see case above);
  • Save and activate rule.

This rule will make customer receive points on registration stage, and they can be already spent on first order.


How can I disable simultaneous Magento's coupon using and spending/earning Reward Points

This can be done in two ways - via setting and via rules.

First way, totally forbids simultaneous using coupons and Reward Points:

  • Go to Reward Points -> Settings -> General Settings -> Use points and coupons at the same time;
  • If you wish to display warning, select Disabled with warning;
  • If you wish to hide Reward Points spending block, select Disabled with block hide.

Second way, allows to flexibly vary policy depending on coupon type and discounting policy:

  • Create a Spending Rule at Reward Points -> Spending Rules;
  • Jump to the Conditions tab, and add one of following condition:
    • Coupon Used, with No value. Forbids spending, when any coupon is used and hides spending block;
    • Coupon Code, with appropriate operator, and coupon code. Allows to forbid spending only when certain code (or their group) is applied.
    • Discount Amount. Forbids spending, when certain amount of discount is applied prior to spending (including custom and by third-party extensions). Zero value allows to forbid spending, when any discount is applied, some numeric value establishes a threshold, above (or under) which Reward Points spending is forbidden.
  • Jump to Actions and set spending rate, as in regular spending rule.

Earning can be forbidden similarly - but only by using rule and conditions, described above.


How can I disable frontend notification about behavioural points awards - for writing a review for example.

All behavioural frontend notifications are governed by Reward Points -> Settings -> Display -> Disable Behaviour Notifications. Select there option Writing a review (along with other frontend notifications, that you wish to hide) and save configuration.


How can I disable Reward Points spending block at Cart or Checkout

Reward Points spending block can be hidden by setting to No options from Reward Points -> Settings -> Display section:

  • for cart: Display Reward Points block on cart page;
  • for checkout: Display Reward Points block on checkout page

How can I enable Rich Pins for my store

Our extension supports Rich Pins by default. The only thing you need to do - set up special additional meta-tags on your product page, which our extension can use.

Here is an official guideline to prepare and enable Rich Pins for your store: Enable Rich Pins for your store


How do I disable certain social buttons

Each social button has its own section at System -> Configuration -> Mirasvit Extensions -> Social Network Settings. For example, if you need to hide Facebook button, open Facebook settings subsection, and set option Show Facebook Like button to No. This will hide that button both from product and category pages.

The same applies to other social buttons.


How do I customize social buttons or/and add custom button for unsupported social network.

Each social button in fact is a separate template, which is bringed together dynamically. So, to customize social buttons, you need to edit these templates:

  • Facebook: /[magento_root]/app/design/frontend/base/default/template/mst_rewardssocial/buttons/facebook/like.phtml
  • Twitter: /[magento_root]/app/design/frontend/base/default/template/mst_rewardssocial/buttons/twitter/tweet.phtml
  • Google+: /[magento_root]/app/design/frontend/base/default/template/mst_rewardssocial/buttons/googleplus/one.phtml
  • Pinterest: /[magento_root]/app/design/frontend/base/default/template/mst_rewardssocial/buttons/facebook/like.phtml
  • Refer friends: /[magento_root]/app/design/frontend/base/default/template/mst_rewardssocial/buttons/pinterest/pin.phtml

If you need to add additional social button, then you need to alter this template: /app/design/frontend/base/default/template/mst_rewardssocial/buttons.phtml

Important note: Adding new social button, described here, is merely cosmetic. Points won't be awarded for custom buttons, because it will require code modification as well. Contact Mirasvit Team or its partners, if you wish not only to have additional button, but include it to the rewards policy as well.


How can I make Facebook like button (or other social button) apply only once per store as a whole (or for certain page)

Pick up a template for a social button (listed in case above), and add desired URL to these locations:

  • Facebook: set URL as value to href attribute of fb:like tag;
  • Twitter: set URL to $currentUrl variable (requires PHP code);
  • Google+: set URL in RewardsGoogleplusOne javascript constructor (requires PHP code)
  • Pinterest: replace $this->getEncodedPageUrl() variable with desired URL.

How can I hide social buttons on Category pages, and display only on Product Pages?

For that you will need to edit our social buttons layout. By default it is located here: /[magento_root]/app/design/frontend/base/default/layout/mst_rewardssocial.xml

Remove from layout block, marked catalog_category_view, and purge ALL cache to make changes apply.

If you use custom layout, then path would be: /[magento_root]/app/design/frontend/[YOUR_PACKAGE]/[YOUR_THEME]/layout/mst_rewardssocial.xml

Find values for placeholders in path above in these settings:

  • YOUR_PACKAGE - System -> Configuration -> Design -> Package -> Current Package Name
  • YOUR_THEME - System -> Configuration -> Design -> Themes -> Layout. If there is empty value, than theme's name is default.

How can I move buttons on Products page.

Social buttons can be moved in two ways, which are dependant from page layout, that you use:

Method 1: move by layout:

  1. Open our social buttons layout, which is located here by default: /[magento_root]/app/design/frontend/base/default/layout/mst_rewardssocial.xml
  2. Find block, marked catalog_product_view, and in child element <reference name="content"> replace name attribute to layout block, under which buttons should appear. Typical locations are:

    • product.info.additional - displays buttons after additional info block of product
    • product.info.media - displays buttons under image of product
    • product.info.addtocart - displays buttons under Add To Cart button

    Valid block names can be seen in layout file below (by default) in section catalog_product_view:

    • /[magento_root]/app/design/frontend/base/default/layout/catalog.xml

    Or, if you use custom theme or custom layout:

    • /[magento_root]/app/design/frontend/[YOUR_PACKAGE]/[YOUR_THEME]/layout/catalog.xml
    • /[magento_root]/app/design/frontend/[YOUR_PACKAGE]/[YOUR_THEME]/layout/page.xml

    Refer to previous case, how to know your package and theme names.

  3. In some cases, when Product page has only content block, or has complex layout, which requires additional buttons adjusting, proceed to next method:

Method 2: move by CSS:

  1. Open our CSS stylesheet, located by default here: /[magento_root]/skin/frontend/base/default/css/mirasvit_rewards.css

  2. Find block, marked .rewardssocial-buttons, and put there additional styles, that precisely reposition our buttons to the proper place.

  3. Purge ALL cache to make changes apply.

In some cases mobile theme requires different position of buttons, while regular theme should remain the same. In this case you need to reposition buttons using styles by adding media section to our stylesheet.

E. q. you need to add code like this, where max-width parameter defines maximum resolution, which triggers mobile layout:

    @media only screen and (max-width: 640px) {
        .rewardssocial-buttons {
            top: 100px;
            left: 10px;
        }
    }

Reward Points