Getting Started

Welcome to the Reward Points + Referral Program documentation.

In this documentation, you will find everything you need to set up your Reward Points service and create a flexible reward policy that can cover almost any marketing strategy.

Our extension allows customers to earn points for different actions, and earn additional points from the so-called thresholds (on reaching some tier of sales amount, for example), and even earn from sharing links on most popular social media networks.

Points earned can be spent on orders, as a dynamic discount, and even used to pay for orders completely.

Go ahead, dive in!

Firstly, please, find our extension in My Downloadable Products section of our store. Learn how to install extension, and proceed with Quick Start, which will guide you to set up your reward policy.

How to install the extension

How to install the extension How to install the extension using composer Backup your store's database and web directory. Login to the SSH console on your server and navigate to the root directory of the Magento 2 store. Copy the installation instructions...

Quick Start

Quick Start Our Reward Points & Referral Program extension for M2 is a simple yet powerful extension that allows customers to build complex reward policies with minimum efforts. Most of its functions work out-of-box. However, if you intend to create ...

Configuration Settings

Configuration Settings Go to Stores > Settings > Configuration > Mirasvit Extensions > Reward Points. You will see there, all the Reward Points settings (except Social Buttons, which have their respective sections), divided into the following...

Social Networks Settings

 Social Networks Settings Our Reward Points extension allows you to place social buttons on Product and Category pages. Even more - using [Behaviour Rules](/rules/earning #behaviour), you can make your customers earn points for sharing your products on...

Transaction Email Templates

Transaction Email Templates In preparing an email, it must have a template of order, invoice, and credit memo, the following variables must be taken note of: {{var order.getRewardsEarnedPoints()}} - number of points earned for order {{var order.getReward...

Earning Rules

 Earning Rules Earning Rules define ways by which customers earn points. To create a new Earning Rule, go to the Marketing > Promotions > Reward Points > Earning Rules and press the button Add New. Editing the page of an earning rule is very c...

Spending Rules

 Spending Rules Spending Rules are much simpler than earning them since they only define the rate, at which points can be converted to discounts. Note Points can be spent when a customer uses a special block. It will appear on both the Cart and the Ch...

Notification Rules

 Notification Rules Notification Rule allows you to set up different messages to your customers, notifying them about their current earning/spending points. To create a new Notification Rule, go to Marketing > Promotions > Reward Points > Noti...

Custom Behavior Events

Custom Behavior Events Using this feature, you can add your own ways by which customers can earn points. To create a new Custom Behavior Rule, go to Marketing > Promotions > Reward Points > Settings > Advanced Settings. In this field Custom B...

General Information

General Information You can use API to attract customers and increase sales rate in your store. At this point, you can simultaneously use Reward Points Extension from external tools that work on separate servers and use other programs, which includes the ...

Example of REST API

Example of REST API To place an order using the Reward Points, you have to complete the following preconditions: The customer should be registered and logged in, as the module doesn't work with guest customers You should have at least one configured and...

GraphQL Objects Reference

GraphQL Objects Reference The full documentation on GraphQL is available on Magento DevDocs page GraphQL Developer Guide To use GraphQL in the Reward Points + Referral program module it is mandatory to install Rewards GraphQl module. Cart object One of ...

Example of GraphQL API usage. Placing an order with the Reward Points + Referral program module

Example of GraphQL API usage. Placing an order with the Reward Points + Referral program module To use GraphQL it is mandatory to install module Rewards GraphQL. Read how to set it up in Prerequisites. In addition to REST architecture and SOAP protocol Ma...

Earning Rules Examples

# Examples of Earning Rules In this section, we will explain the possible configurations of typical rules. Behavior Rules Give 5 points for a sign up in the store A customer signs up in the store and receives points. Type: Behavior Rule Is Active:...

Spending Rules Examples

#Examples of Spending Rules In this section, we will explain the possible rules for configurations. For every 10 points give a $1 discount The customer will get $1 discount for every 10 points spent. Is Active: Yes Customer Groups: All Conditions:...

Examples of Notification Rules

Examples of Notification Rules In this section, we shall explain the typical rules of configuration. My Reward Points Description The rule will show a notification message in the "My Reward Points" section in the customer's account. Is Acti...

Reports

 Reports Reports on our extension, are divided into two separate menu actions: Refresh Statistics, which is used in keeping statistics up to date, and concentrating data for displaying. Reports, which is used in the visualization of data. These actio...

Importing Data

# Importing Transactions Our extension allows data importing from other extensions using the CSV data format. Note Unfortunately, we can not add a download sample file due to Magento restrictions. You can get a sample file by creating a manual transac...

Building Referral Program

Building Referral Program Our extension provides tools in creating a flexible referral program. Here is how it works: The Customer invites some referees to the store, by using the My Referrals section on his account. There are two ways to do this: By se...

How-To

How-To Contents How can I make Customer earn points after buying some specific products How can I prevent rules from multiply? How can I set up a rule to award for both referral customers, and their referee How can I create so-called 'threshold' and 'mil...

Migration from Magento 1 to Magento 2

Migration from Magento 1 to Magento 2 Below are examples of the script, which may be used in transferring data from Mirasvit Reward Points for Magento 1 to Mirasvit Reward Points for Magento 2. To use this script, you will need the help of a PHP developer...

How to upgrade extension

How to upgrade extension To upgrade the extension, follow these steps: Backup your store's database and web directory. Log in to the SSH console in your server and navigate to the root directory of the Magento 2 store. Run command composer require mirasv...

Disabling the Extension

Disabling the Extension Temporarily Disable To temporarily disable the extension please follow these steps: Login to the SSH console on your server and navigate to the root directory of the Magento 2 store. Run the command php -f bin/magento module:disab...

Change Log

Change Log 3.0.36 (2021-08-20) Fixed Tier calculations do not include rewards discount Tiers weren't updated for all the customer groups in the store Guest customer is redirected to 404 when press 'Refer Friend' button Improvements Compatibility with M...