Reward Points

Overview

In the 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 the 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 the 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.

Download & Install

You can download from the following resouces:

• Mageplaza
• Magento Marketplace
• How to Install

How to use

I. For customers

Customers can earn reward point(s) and use them perfectly in these following pages:

1.1. The checkout page

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

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 instruction 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

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 of 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 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 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 in here. However, decimal numbers are not approved at Point section. If admins enter a decimal number, they will be rounded following the rule in 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 which have similar priorities, rules will apply on the rate which has a smaller ID first.

II. Spending Rate.

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 an spending rate such as Website, Customer Group(s), Spending Point(s), Discount Received and Priority. Also, admins can edit rate:
  • To edit an 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 in 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 number, the lower priority.
  • If there are many spending rates which have similar priorities, rules will apply on the rate which has a smaller ID.

III. Transactions.

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 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 be expired 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 which 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 in the View Transaction page.

IV. Configuration.

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

4.1. General Configuration.

This general configurations can apply for the whole module.

• In the Enable field: Choose “Yes” to active 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 Maximum Available Point Balance field

  • Set the maximum number of point(s) that the customer can accumulate by purchasing.

  • If customer's account balance reaches to 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: Selct 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.

Highlight Point on Storefront

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

4.2. Earning Configuration.

4.2.1. General

This displays general configurations regarding earning point(s)

• 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 Points Earning From Tax field: Select “Yes” so the tax can be converted to earning point(s)

• In the Earn points from shipping fee: Select “Yes” to allow Shipping Fee to be converted to point(s).

• 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 Earning Points from Orders with Spent Points: Select Yes so that when customers spend points in a order, they still can earn points from that 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 frontend.

  

• 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.

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 the Discount Label field: Discount Label displayed on the frontend will change according to the content of this section.

• 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 Points Spending From Tax: Select "Yes" to allow customers apply points to tax discount

• In the Spending Points on Shipping: Select “Yes” to allow customers to use their point(s) to reduce the shipping cost.

• 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.

4.4. Display Configuration.

Basic configuration for display of Reward Point and Earning Point:

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

• In the Hide Total Points on Top Link if the Reward Points balance is empty or equals to zero: Select Yes to hide the total points of customer on the Top Link if the Reward Points balance is null or equals to zero.

• 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 at the Minicart page.

4.5. Email Configuration.

• 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 notification 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 exprire
  • To change the Gift Card Email template, admins can create another one under Marketing > Email Template.
  • The instruction 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 Point that Customer is having.
  • Total Earning Points: The total Reward Point that Customer earned when making order.
  • Total Spending Points: The total Reward Point that Customer spent.

• In the Update Balance field: Allows admins to change the balance by filling in Update Point and set 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 will be 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 was 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 details
  • 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 expired.
• All information here is synchronized in the backend Customer > Reward Points

7.1.2.

On the Transaction tab, all the rewarded transaction 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.

6.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, get config reward information. Customer can use reward points for order 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.

XI. 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