Reward Points

Overview

In modern marketing, loyalty programs play an important role that can't be denied. Online stores put a lot of effort into keeping old customers and increasing sweet engagement scent between customers and stores. Hence, Mageplaza Reward points extension is developed to increase the interaction between customers and store owners to establish a great consumption cycle on your website.

Magento 2 Reward Points extension will allow earning unlimited reward points as well as using them flexibly as payment methods if necessary. By this way, it is not complicated to build a loyal customer network supplying the number of leads for the merchants.

The Reward Points system does not apply for guest customers.

The Product's Earning Point may vary according to a specific Customer Group and Earning Rate set in the backend.

Outstanding Features

STANDARD	Outstanding Features	Description
1	Custom Point Earning Rules	Allow store owners to set different rules and conditions for earning points based on each website or customer group. Customers can earn points from their purchases. This helps store owners turn infrequent shoppers into loyal customers with an effective reward program.
2	Enhance customer experience in purchasing and using reward points	Customers can redeem points for discounts. The module provides options to configure point values ​​and redemption thresholds. Spend sliders enhance the customer experience. By simply dragging the slider, customers can easily apply the desired amount of points to their purchases, making the checkout process faster and more convenient. Additionally, store owners can enable a one-click redemption option, allowing customers to easily use all their reward points at checkout. This streamlined functionality saves valuable time and enhances the overall customer experience, promoting a seamless and user-friendly interaction with the rewards program.
3	Optimize reward points management	Admins can manage, add and subtract customer reward points across multiple stores from a single admin dashboard. Admins can set expiration dates for reward points to encourage customers to use points promptly and maintain engagement. Additionally, sending automated emails to notify customers of earned points, upcoming expirations, and redemption opportunities will increase customer purchase rates.

Installation Guide

We offer two methods for installing our plugins: the Copy & Paste method and the Composer method. Please follow the detailed instructions provided below.

Method 1: Installation via Copy & Paste

To install our plugins using the Copy & Paste method, kindly follow the instructions at the link below:

How to Install Magento 2 Extension via Copy & Paste

Method 2: Installation via Composer

Composer name: mageplaza/module-reward-points

To install our extensions using Composer, please refer to the comprehensive guide at the link below:

How to Install Magento Extension via Composer

By following these guides, you can ensure that the installation process is handled correctly, allowing you to fully utilize the features and benefits of our plugins.

Module Update Guide

Keeping your module updated ensures optimal performance. Follow one of these steps to update your module:

1. By Account Dashboard: Log in to your Mageplaza account > go to the My Licenses section > click on the Download button > choose the latest version from the popup.
2. By composer: Kindly use the following commands to update the module via composer

composer require mageplaza/module-reward-points
php bin/magento setup:upgrade
php bin/magento setup:di:compile

Updating a module by Composer ensures efficient dependency management, version control, and integration with development tools, making the process faster and more reliable.

Guide to install the library​

Please run the below command to install the module library:

composer require liquid/liquid

How to use

I. For customers

Customers can earn reward point(s) and use them perfectly on the following pages:

1.1. The checkout page

• Customers can use their earned reward point(s) to discount the order.
• This page also displays the earning point(s) customers will receive when they place the order.

1.2. View Cart Page (Shopping Cart)

• This is familiar to the checkout page.
• However, Earning Point(s) can’t be shown on this page if admins disable the field Display Earning Points on Shopping Cart in the backend.
• Notice: Earning Point(s) can be different depend on Customer Group and Earning Rate which are configured in the backend.

II. For admins (store owners)

• Admins are able to create and manage Earning Rate, Spending Rate and Transaction as well as to configure the Reward Points extension generally in the backend.
• Admins are able to apply changes to reward point(s) in the customer’s account in the backend.
• Admins are not supported to use reward point(s) when creating a new order at the moment.

How to configure

Log in to your backend, then go to Marketing > Reward Points

and follow the instructions below to configure Reward Points extension.

• Earning Rate
• Spending Rate
• Transactions
• Configuration

Earning rate and Spending Rate are stored in the same table inside the database. Therefore, the admin will probably see a slight difference in IDs of rates.

I. Earning Rate

Admins can set, check, and edit customer point earning rates depending on the website or customer group. This helps store owners set up policies on point exchange rates to the corresponding amount of money to encourage customers to buy to receive more bonus points.

Go to Marketing > Reward Points: Earning Rate

1.1. General Management.

This is the place where admins can store Earning Rates created.

• From the grid view, admins can acknowledge some fundamental information about Earning Rate such as Website, Customer Group(s), Money Spent, Earning Point(s) and Priority. Also, admins are able to Edit Rate:
  • To edit an earning rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.
• To delete rate, go to the edit page, choose Delete

1.2. Add/Edit New Earning Rate

After entering the Earning Rate section, click on Add New Rate to create a new earning rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the earning rate.
• In the Customer Group(s) field:
  • Only customers who belong to this group can be entitled to this earning rate.
  • Customers who belong to different groups can receive different earning rates even when they purchase the same product.
• In the Earning Rate field
  • Define the conversion rate from X (currency) to Y (point)
  • Admins can fill out the appropriate rate here. However, decimal numbers are not approved at Point section. If admins enter a decimal number, they will be rounded following the rule in the configuration part
• In the Priority field:
  • Indicates the priority of this earning rate compared to other earning rates.
  • 0 indicates the highest priority. The higher number, the lower priority.
  • If there’re many earning rates that have similar priorities, rules will apply to the rate that has a smaller ID first.

II. Spending Rate.

Admins can set, check, and edit customer point usage rates depending on the website or customer group. This helps store owners set up policies on point usage rates corresponding to the appropriate amount to increase sales without affecting store revenue.

Follow the way Marketing > Reward Points: Spending Rate

2.1. General Management.

This is the place where admins can store Spending Rates created.

• From the grid view, admins can acknowledge some fundamental information of a spending rate such as Website, Customer Group(s), Spending Point(s), Discount Received and Priority. Also, admins can edit rate:
  • To edit a spending rate, choose “Edit” in the Action column.
• Admins can filter, hide or display Column or export rates.
• To delete rate, go to edit page, choose Delete

2.2. Add/Edit New Spending Rate.

After entering the Spending Rate interface, select Add New Rate to create a new spending rate. Then, click Save and Continue Edit, the page will automatically switch to the Edit Rate page.

• In the Website field: Choose website(s) you want to apply the spending rate.
• In Customer Group(s) field
  • Only customers who belong to this group can use their point(s) following this spending rate.
  • Customers who belong to different groups use different spending rates even when they purchase the same product.
• In Spending Rate field
  • Indicates the conversion rate from X (point(s)) to Y (currency)
  • Admins can fill out an appropriate rate here. However, decimal numbers are not approved. If admins enter a decimal number, they will be rounded following the rule >= 0.5 to 1, or < 0.5 to 0.
• In Min Point: set the minimum number of points that can be spent when order
• In Priority field
  • Indicates the priority of this spending rate compared to other spending rates.
  • 0 indicates the highest priority. The higher the number, the lower the priority.
  • If there are many spending rates that have similar priorities, rules will apply to the rate that has a smaller ID.

III. Transactions.

Admins can manage and check customers' point earning or point usage transactions. In addition, they can add or subtract bonus points according to each customer's situation.

The right path is Marketing > Reward Points: Transaction.

3.1. General Management.

This is the place where admins can create and manage transactions. By entering this interface, admins can add/minus customer’s reward point(s).

• From the grid view, admins can acknowledge some fundamental information of created transactions such as ID, Customer, Comment, Amount, Status, Store View, Created Date. Also, admins can:
  • View: To review a transaction, choose “View” in the Action column.
  • Cancel: To cancel a created transaction (in case its expiration date hasn’t come yet), select the transaction and choose “Cancel” in the Action box (at the left of the grid).
  • Expired: Admins need to take this action if a transaction isn’t expired automatically. At this point, take the same action when admins view/cancel a transaction, choose “Expired” then process with the OK button.
• Admins can filter, hide/display Column or export transaction.

3.2. Add new transaction.

After entering Transaction tab, choose Add new transaction to generate a new transaction. Next, click Save and Continue Edit, the page will direct you to the View Rate page.

• In the Customer field

  • Click this section to display the store’s customer list in the popup form. Admins can only choose 1 from this customer list.
  • Name of the chosen customer will be added reward point(s) to her/his account.
  • If you leave this field blank, there will be an error message.

• In the Point(s) field

  • Enter the number of point(s) you want to add for the chosen customer.
  • If you enter negative numbers or leave it blank, there will be an error message.
  • If you enter a decimal number, it will be rounded down (E.x: 1.8 = 1.1 = 1)

• In the Comment field

  • Enter the comment that will be sent along with the added point(s) to the chosen customer.
  • You can leave this field blank.

• In the Points expire after field

  • The added point(s) of this transaction will expire after X day(s) from the time you create this transaction.
  • Admins have the right to add higher point(s) than the maximum point of the amount that a customer can accumulate (E.x: max point = 1000, admins can add 1100 points or even more to the customer balance).

  Note: Transaction is allowed adding point only, cannot subtract point. If you want to remove the added points, please click Cancel

3.3. View Transaction.

Admins can review or expire a transaction on the View Transaction page.

IV. Configuration.

In this section, admins can enable or disable the module, set conditions for earning and using points as well as email notifications about point changes and bonus point expiration dates.

Follow in the backend Store > Settings > Configuration. At the left panel, choose Mageplaza > Reward Points

4.1. General Configuration.

These general configurations can apply to the whole module.

• In the Enable field: Choose “Yes” to activate the Reward Point extension from Mageplaza.

• In the Label in My Account Navigation field: Enter the name of Tab Reward Point displayed on the frontend at the My Account > Reward Point section.

• In the Point Label field:

  • This label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.

• In the Plural Point Label field:

  • If the balance is greater than 1, this label will be displayed on the frontend.
  • If you leave it blank, there will be an error message.

• In the Display Point Label field:

  • Select After Amount to display the point label after number (ex: 5 points).
  • Select Before Amount to display the number label before number (ex: points 5).

• In the Zero Point Label field:

  • Enter the label when the customer's account balance is equal to 0.
  • If you leave it blank, there will be an error message.

• In the Show Point Icon field: Choose “Yes” to display the point icon on the frontend.

• In the Reward Point Icon field:

  • The upload image will be used as the point icon and be shown on the frontend.
  • JPG, PNG or GIF files are accepted. There will be an error message if the input file is invalid.
  • If you leave it blank, the default icon will be used .

• In the Highlight Point on Storefront field

  • Show in Cart: Choose Yes to enable the highlight point in Shopping Cart page > Summary Cart
  • Show on Checkout Page: Choose Yes to enable the highlight point in the Checkout page
  • Text Color: choose the highlight color

• In the Maximum Available Point Balance field

  • Set the maximum number of point(s) that the customer can accumulate by purchasing.
  • If the customer's account balance reaches this number, there will be no more points awarded to the balance.
  • Admins can add point(s) to an account balance with no awareness of this value.
  • If the field is left blank or 0, there will be no restriction for the maximum points

• In Redirect to My Points and Rewards page after customer login account field: Select Yes to redirect customers to My Points and Rewards page right after customer logs in or creates an account.

Landing Page

• Choose Landing Page: Select the page to show when clicking on the Landing Page link.

• Display Landing Page On Footer Link: Select Yes to show Landing Page Link in the Footer.

• Landing Page Label: Enter the label to show Landing Page link in the Footer.

4.2. Earning Configuration.

In this section, admins can set up rules for earning points from taxes or limit the maximum amount of points that customers can earn, the time customers can receive points or the expiration time of points. This helps admins manage and create appropriate policies for providing bonus points to customers.

4.2.1. General

This displays general configurations regarding earning point(s)

• In the Earning Point Source field: There are 2 options:

  • Earn points from Tax: Select Yes so the tax can be converted to earning point(s)
  • Earn points from shipping fee: Select Yes to allow Shipping Fee to be converted to point(s).

• In the Earning Points from Orders with Spent Points: Select Yes so that when customers spend points in an order, they still can earn points from that order.

• In the Type of Maximum Earning Points per Order: Choose how to calculate the maximum allowed points for each order. There are 2 types:

  • Fixed: Set the maximum allowed points as a fixed value set in the Maximum Earning Points per Order field.
  • Percent: Set the maximum allowed points as a percentage of the cart set in the Maximum Earning Points per Order field.

• Maximum Earning Points per Order: Set the maximum allowed points customers can get for each order. If left empty or 0, the maximum point is unlimited.

• In the Rounding Method field: There are 3 options for rounding

  • Normal: The number of points converted from the currency (USD, EUR, ...) will be rounded according to the normal rule. E.x: 10.2 rounded to 10; 10.8 rounded to 11.
  • Rounding Up: The number of points converted from the currency (USD, EUR, ...) will be rounded up. E.x: 10.2 or 10.8 is rounded to 11.
  • Rounding Down: The number of points converted from the currency (USD, EUR, ...) will be rounded down. Ex: 10.2 or 10.8 is rounded to 10.

• In the Point Refund field: When the customer places an order, they will receive a certain amount of earning points. The shop owner selects “Yes” in this section to retrieve the points when customer refunds the order.

• In the Notify reward points for guests: Select Yes to notify customers when they have not registered or logged in to their accounts.

• Message: Enter messages to show customers on the frontend.

4.2.2. Sales Earning Process.

• In the Earning Points after Invoice created field:

  • Select “Yes” to allow adding earning point(s) to the customer's account right after the invoice is created.
  • Select “No” to allow adding earning point(s) after the order is completed.

• In the Points Expired After field

  • The number entered here is expiration day of point(s), it starts to count from the day point(s) is (are) added.
  • If this field is blank, point(s) will be used indefinitely.

4.3. Spending Configuration.

In this section, admins can set up rules for using points related to taxes or limit the amount of points that customers can use, the time customers can receive bonus points or the expiration time of bonus points. This helps admins manage the use of bonus points by customers, both stimulating customers to buy and creating revenue for the store while limiting losses when selling a product with bonus points.

• In the Spending Point field: there are 2 options:

  • In the Points Spending From Tax: Select "Yes" to allow customers to apply points to tax discounts.
  • In the Spending Points on Shipping: Select “Yes” to allow customers to use their point(s) to reduce the shipping cost.

• In the Minimum balance to Spend Points field

  • Set the minimum number of point(s) that customers must have in their balances as a condition to spend points on discounting orders.
  • If the number of point(s) in the customer's balance is less than the minimum spending point, the Reward Points slider will not appear on the View Page or Checkout Page.
  • If you leave it blank or 0, the default minimum point is 0.

• In Type Maximum Spending Points per Order: Select how to set the maximum number of points allowed per order:

  • Type Maximum Spending Points per Order = Fixed: the maximum number of points used for each order with a fixed value set in Maximum spending points per order field
  • Type Maximum Spending Points per Order = Percent: the maximum number of points used for each order is set as a percentage of the total shopping cart value, set the maximum value in Maximum spending points per order field

• In the Maximum spending points per order field:

  • Set the maximum number of point(s) that customers can use on an order.
  • If you leave it blank or 0, the maximum number of point(s) customers can spend is unlimited (it can be the maximum number of points they own or the maximum number of points which can be converted by SubTotal of Cart).

• In the Restore spent points after order refunding field: When customers place an order, they can apply a certain amount of their reward point(s). Admins select “Yes” in this section to return point(s) to customers if their orders are refunded.

• In the Use Max Point By Default field: Select “Yes” to set the customer's spending point(s) to the maximum number that they can use.

• In the Discount Label field: Discount Label displayed on the frontend will change according to the content of this section.

4.4. Display Configuration.

The points displayed on the minicart are the points the customer will receive when placing an order to help the customer easily know how many points they will receive. This section also includes accumulated points on Top Link that help customers easily track their current points without having to go to another page to check. This makes customers' payment easier, faster and more convenient.

Basic configuration for the display of Reward Points and Earning Points:

• In the Display Total Points on Top Links field: Select “Yes” to display the total number of reward point(s) that the customer has on Top Link.

• In the Display Earning Points on Minicart field: Select “Yes” to show the total number of earning point(s) customers can receive when checking out the cart on the Minicart page.

4.5. Email Configuration.

Admins can set up email notifications about changes in each customer's reward points as well as the expiration date of the reward points. This helps customers update their current reward points as well as the expiration date of the points. This can encourage customers to use the points, promoting the purchasing process quickly.

• In the Enable Notification Email field: Select “Yes” to allow notification emails to be sent to customers.
• In the Subscribe customers by default field: When a new customer subscribes to a store, receiving no emails is set as default. Select “Yes” in this section so that when their first transaction is made (by purchasing or by admin), Reward Points Notification will be checked immediately.
• In the Sender Email field: Admins can choose one of the 5 available Magento Senders: General Contact, Sales Representative, Customer Support, Customer Email 1, Customer Email 2

4.5.1. Update Point Balance Email

• Enabled: Choose “Yes” to send email notifications to customer when their point balance changes

• In the Update Balance Template field

  • Choose email template to send to customer when their point balance changes
  • To change Email Template, admins can create another one under Marketing > Email Template.
  • The instruction to create a new Email Template can be found here.

4.5.2. Points Expiration Email

• Enabled: Choose “Yes” to send email notification to customer when their points are going to expire

• Send Before:

  • Admin set the days the email will be sent before the expiration date
  • If left blank or = 0, reminder email will not be sent

• In the Points expiration Template field:

  • Choose email template to send when customer points are going to expire
  • To change the Gift Card Email template, admins can create another one under Marketing > Email Template.
  • The instructions to create a new Email Template can be found here.

V. Manage Reward Point of Customer

Admins can manage Reward Points Balance, Transactions and Notification of customers by going to Customer > Edit Customer > Reward Points.

• Tab Balance Information let admin know:

  • Current Balance: The total Reward Points that the Customer has.
  • Total Earning Points: The total Reward Points that the Customer earned when making an order.
  • Total Spending Points: The total Reward Points that the Customer spent.

• In the Update Balance field: Allows admins to change the balance by filling in Update Point and setting its expiration date. Admins can also enter the reason for the change in the Comment field

• In the Email Notification field: Admins can register or cancel the subscribe on behalf of the customer when their balance is updated or point(s) is about to expire.

• In the Transactions: Displays information about reward points of customers including: ID, Title, Action, Amount, Status, Store View, Created On, Expire On.

The information about Balance, Notification and Transaction in the backend will be synchronized with the customer's frontend at My Account > My Points & Reward.

VI. Refund Spent Points

With orders that can be applied reward points to get discount, when they are refunded, the points used before can be refunded by store admin.

Click on the checkbox Refund Order to Points to refund points, the field Reward Point Refunded will be displayed

• Reward Point Refund: fill in the points refunded, this value must be smaller than the Spent Points used before for the order

VII. Customer Frontend.

7.1. My Account > My Points & Reward.

7.1.1. Reward Dashboard

Customers can check the Reward Point information in this section after logging in:

• Available Balance: Show the available points of customers, equal to the Current Balance check at Backend.

• Total Earned: Show the earning points of customers, equal to the Total Earning Points check at Backend.

• Total Spent: Show the spending points of customers, equal to the Total Spending Points check at Backend.

• Reward Information indicates

  • Earning Rate and Spending Rate that customer is entitled (according to his Customer Group and Website set in the backend).
  • The maximum number of points that the customer's balance can receive from orders.
  • The maximum number of days that point(s) can be used since that customer receives point(s).

• At Recent Transactions: Customer can know the transaction history in detail

  • Made transaction(s) and its comments.
  • Number of point(s) changed
  • Date and time of the transaction
  • Expiration Dates of point(s)
  • Transaction status

• They can also sign up to receive updates when their balance changes or point(s) is about to expire.

• All information here is synchronized in the backend Customer > Reward Points

7.1.2.

On the Transaction tab, all the rewarded transactions of customers are shown

7.2. Checkout Page

• Customers can use the slider or text box to select the amount of reward point(s) they want to spend.

• Used reward point(s) can be limited to a range.

  • Customers are only allowed to use their point(s) within this range.
  • If Subtotal has a value less than the minimum value of the limited value range, the Apply Reward Point section will not be displayed.

• Tick the checkbox Maximize my discount with Point to use all available points at once. The amount of points can be

  • The total points that customer has if Total Point(s) < Max Point for per Order and Subtotal.
  • Max Point if Max Point < Total Point and Subtotal.
  • The number of point(s) which is equal to Subtotal if that amount < Max Point and Total Point.

• The Order Summary box will display more sections about reward points to make the calculation easier.

• Spending Point can be used for Tax, Shipping Fee if it’s configured in the backend.

• The conversion rate between Reward Point and Spending Point depends on the Spending Rate configuration in the backend.

7.3. Other additional frontends.

• Top link: Displays the point(s) that customer has.

• MiniCart: Displays the earning point(s) of all products in the cart.

• View Cart Page (Shopping Cart): Displays Apply Reward Point on the checkout page, and also displays the Earning Point, Spending Point and Reward Point.

VIII. REST API

Mageplaza Reward Points Standard supports using REST API to make requests related to Transaction, Customer's Reward account, Reward rate, and config reward information. Customers can use reward points for orders via Rest API.

View details of endpoints of Mageplaza Reward Points Standard here.

View REST API guidelines of Magento 2 here. Guidelines to create tokens here.

IX. GraphQL

9.1. How to install

Run the following command in Magento 2 root folder:

composer require mageplaza/module-reward-points-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Note: Magento 2 Reward Points GraphQL requires installing Mageplaza Reward Points in your Magento installation.

9.2. How to use

To perform GraphQL queries in Magento, please do the following requirements:

• Use Magento 2.3.x or higher. Set your site to developer mode
• Set GraphQL endpoint as http://<magento2-server>/graphql in url box (e.g. http://dev.site.com/graphql)
• View details of queries supported by Mageplaza Reward Points GraphQL extension here

X: FAQs

Is the Milestone program necessary?

The answer is yes. The Milestone program effectively encourages shoppers to interact more with the store by offering higher incentives for each upper membership level. It simply motivates people by explaining the more points they have, the more benefits they'll get.

Does this loyalty program extension allow the shoppers to gain points for a purchase if they use the rewarded points on that purchase?

Absolutely yes, the customer can use existing points and gain new points on the same purchase.

Can a loyalty program be set up for specific customer groups?

Sure. You can set specific customer groups for each loyalty program by navigating to its settings in the backend. Then, choose one or multiple customer group(s) you want to apply for that.

Can I create many Magento rewards programs at the same time?

Yes, you can initiate many loyalty programs at once by setting various earning rates in the backend.

What will happen if buyers return the order they've already received the rewarded points earlier?

Don't worry. The rewarded points will automatically be revoked.

Can I send auto email reminders X days before the credit expiration date?

Yes. The Reward Points extension for Magento 2 is designed with built-in email configuration, allowing store owners to set Point Expiration Email with a pre-made template.

Can I display motivating messages notifying shoppers about the points they get if they complete an order?

Absolutely! To motivate customers with attractive messages when they place an order, you can customize that loyalty program's description in the backend.

How can I track the customer's transactions with points?

Tracking customers' transactions with points is really easy with Mageplaza's reward program extension. The module provides a transaction history grid that automatically updates all users' transaction information like amount, status, created and expiration dates, etc.

XI. Support and Assistance

1. Customer Support

For any assistance, please visit our Support page or email us at cs@mageplaza.com/ sales@mageplaza.com

2. Create a Ticket

If you have technical issues, please open a ticket at this link.

Operating Hours

Our support team is available during the following hours:

• Monday to Friday: 8:00 AM - 23:59 PM
• Saturday: 8:00 AM - 12:00 PM
• Sunday: Closed

Refund Policy

We understand that sometimes things don't go as planned. Please review our refund policy for detailed information: Refund Policy Link

Frequently Asked Questions (FAQ)

For quick answers to common questions, please visit our FAQ page: FAQ Page Link