exto reward points for magento 2 (user guide)
TRANSCRIPT
Rewards Points for Magento 2.0
USER GUIDE Version 1.0
https://exto.io/rewards-points-for-magento-2.html
Magento 2 Reward Points extension provides you with effective rewards program, customizable in every aspect, with full set of features included.
Full control over your campaigns with advanced dashboard
Flexible points earning rules for any occasion
Set thresholds and never slip out of profit-making levels
Points expiration for additional shopping incentive
Refund by points and leave money on your accounts
Reward Points for Magento 2
Table of Contents
Table of Contents
1. Quick Start
1.1 Installation
2. Admin Area
2.1 Using the Dashboard
2.2 Viewing customer’s reward points balances
2.3 Managing reward points balance per customer
2.4 Viewing reward points used with an order
2.5 Using Reward Points with New Order
2.6 Refunding with Reward Points
2.7 Earning Rules
2.7.1 Add/Edit a rule form
2.8 Thresholds
2.9 Viewing the list of Reward Points Transactions
2.10 Changing the Settings
3. Customer Area
3.1 Viewing My Reward Points
3.2 Viewing Orders with Reward Points transactions
4. Shopping Cart
4.1 Using Reward Points With New Order
2 of 26
Reward Points for Magento 2
1. Quick Start
1.1 Installation
1. Back up your web directory and store database. You can make backup copies with any tool you find appropriate. If you are going
to use the native Magento backup function, then navigate to:
Systems > Tools > Backups
and make System and Database backups
Image 1. Create backups
2. Download the Exto Reward Points installation package.
3. Upload the contents of the Exto Reward Points installation package to your store root directory.
4. In the SSH console of your server navigate to your store root folder:
cd path_to_the_store_root_folder
Then run:
php -f bin/magento module:enable Exto_Points
Next run:
php -f bin/magento setup:upgrade
3 of 26
Reward Points for Magento 2
Then run:
php -f bin/magento setup:static-content:deploy
Finally run:
php -f bin/magento cache:clean
php -f bin/magento cache:flush
Flush the store cache, log out from the backend and then log in again.
2. Admin Area
2.1 Using the Dashboard
Rewards Points Admin area is located in the Marketing backend section.
Marketing > Exto Rewards Points > Dashboard
The dashboard contains the following information:
Field Value Description
Points system status ON/OFF value signifying if the points system is active or inactive
Exchange Rate Conversion Rate of points to currency (eg. 5 points to $1)
Customers Engaged with the Program Number of customers who have positive reward points balance (eg. 5 with positive balance)
Balance Update Subscribers Number of customers with rewards points balance updated (eg. 3 of 147 total customers)
Current balance Value of all reward points earned across whole store
Earned points Table showing earned points today/yesterday/this week/this month/last month
Spent points Table showing spent points today/yesterday/this week/this month/last month
Expiration Points Table showing points expiration prognosis tomorrow/this week/next week/next 30 days
4 of 26
Reward Points for Magento 2
Active Rules
List of active rules, with number of triggers and points earnings today/yesterday/this week/this month/last month (a trigger is complete once points are credited towards customer balance). To edit the rule, click on the “Edit rule” link next to each rule. For more information on how to edit a rule, proceed to step 2.7.
Image 2. Rewards Points Dashboard
2.2 Viewing customer’s reward points balances
Customers > All Customers
Search for the corresponding customer on the All Customers list. The value on the Points column shows the currency equivalent of the
customer’s rewards point balance.
5 of 26
Reward Points for Magento 2
Image 3. Rewards Points Balance
2.3 Managing reward points balance per customer
Customers > All Customers > Customer Information > Exto Reward Points
Navigate to the Customer Information page to manage Rewards Points per customer.
The Update balance form consists of:
Field Value Description
Balance Change
Indicate a positive number or use a negative ‘-’ sign to subtract. The system will apply the exchange rate to the value indicated here and add to the customer’s current balance. For example, 73 points is equivalent to $14.6. With a starting balance of $20, the new balance will now be $34.6
Expiration Indicate an expiry date. No expiry if the field is left empty.
Comment Any text comment for the customer
Once done updating the customer reward points details, click on the Update Balance button.
6 of 26
Reward Points for Magento 2
Image 4. Managing Rewards Points
Image 5. Successful message after adding Reward Points
7 of 26
Reward Points for Magento 2
Scroll down to the bottom of the page to find information on previous reward points transactions.
The table consists of:
Field Value Description
Transaction ID Reference number of the transaction
Balance Update Value Value shown in this field is the points equivalent (green is for addition, red is for deduction)
Date Date when the reward points transaction was made
Points Expiration Date Date when the earned points are set to expire
Image 6. Rewards Points Transactions
2.4 Viewing reward points used with an order
Sales > Orders > Order Information
Find the corresponding order number and on the information screen, scroll down to the bottom of the page. The Paid with Points information
shows the currency equivalent of the points used for the specific order.
8 of 26
Reward Points for Magento 2
Image 7. Reward Points Usage in Order Information
2.5 Using Reward Points with New Order
Sales > Orders > Order Information
Admin users can create new orders with reward points. Create a new order and indicate the reward points value to be applied in the Points
field.
Click on the arrow sign to apply the reward points value.
Image 8. Using reward points for a new order
Scroll down to the Order Totals section to validate if the points have been applied. The value shown is the currency equivalent of the points
applied.
Click on Submit Order once done.
9 of 26
Reward Points for Magento 2
Image 9. Applied Points on Order Totals
If a value more than the customer’s reward points balance is indicated, the system will show a “Points balance is not sufficient” error
message.
2.6 Refunding with Reward Points
Sales > Orders > Order Information > Credit Memo
Refunds can be made to the reward points.
When creating a Credit Memo, indicate a value in the Refund with Points section. Admin users can either indicate a portion of the refund
amount or the entire refund amount.
10 of 26
Reward Points for Magento 2
Image 10. Refunding to the customer’s reward points balance
Click on the Refund Offline button once done.
Once admin user checks on the customer’s rewards points transactions, the corresponding transaction record will be shown with the comment
Refund for Order #xxxxxx .
Image 11. Sample Transaction record for refunding to reward points
Admin users also have the option to Cancel earned Reward points to revert the earned rewards points for a refunded order.
If some of the earned points were already used for another order, the system allows cancellation of the remaining reward points balance. If a
customer earned 200 points on a refunded order and used up 100 points on another order, admin user can cancel the remaining 100 points.
11 of 26
Reward Points for Magento 2
Click on the checkbox to refund the remaining earned points.
Image 12. Canceling Earned Reward points
2.7 Earning Rules
Marketing > Exto Rewards Points > Earning Rules
There are 2 types of earning rules: Shopping Cart and Behavioral.
The Shopping Cart rule is based on the shopping cart content while the second one can be behavioral triggers such as the customer’s
birthday, non-login period, review, and store and newsletter signup. Earning rules define the conditions that allow customers to earn points
and the corresponding earning amounts.
The Earning Rules form consists of a grid displaying all configured earning rules and button Add Rule.
Table consists of:
12 of 26
Reward Points for Magento 2
Field Value Description
Rule ID
Rule Title
Points Value Number of points to be earned, or % of cart total
Total Triggers Number of transactions that triggered the rule
Rule Type Value can either be Shopping cart or Behavioral
Active Yes/No value signifying if the rule is active or inactive
Image 13. Earning Rules table
2.7.1 Add/Edit a rule form
To add a rule, click on the Add Rule button.
The form is separated into 3 sections with an additional section for behavioral rule types:
● Rule Information
● Conditions
13 of 26
Reward Points for Magento 2
● Actions
● Email Notifications - this section is only shown when creating a behavioral rule type
Image 14. Editing the Rule Information section
Fill out the values for the following fields in the Rule Information section:
Field Value Description
Title
Customer Comment This is what customers will see in their transaction list
Rule type Choose between Shopping cart or Behavioral. Once a rule is saved, this can no longer be altered
Active Toggle between Yes or No to signify if the rule is active or inactive
Customer Groups All customer groups are selected by default
Active from <date> Rule activation date
Active to <date> Rule deactivation date
Priority indicate a value for rule priority when applying more than one rule at the same time
14 of 26
Reward Points for Magento 2
Next, proceed to the Conditions section.
The contents of this section depends on the selected rule type. In case of Shopping cart rule type, the system displays the Conditions section
along with the standard Magento rule creator.
Image 15. Conditions for a Shopping Cart Rule
Fill out the following fields to create a Shopping Cart rule. Leave the fields blank to indicate no limit. All conditions must be satisfied before
customers can earn reward points.
Field Value
Minimal cart value Minimum cart value that should be met before reward points can be earned
Minimal cart item qty Minimum number of items in the cart that should be met before reward points can be earned
Trigger Limit per Customer Maximum number of times that the rule can be triggered for each customer
Daily Trigger Limit Maximum number of times that the rule can be triggered for each customer per day
For additional rules, use the standard Magento rule creator.
15 of 26
Reward Points for Magento 2
Image 16. Standard Magento rule creator for Shopping Cart rule type
In case on Behavioral, the system will show a selection box with the following values. Choose from any one of these behavioral triggers:
Image 17. Conditions for a Behavioral Rules
● Store signup
● Newsletter signup - integration with standard Magento newsletter
● Product review
● Customer birthday
● Customer nologin period
○ Days - indicate the number of days which must pass since last login to trigger the rule
Next, proceed to the Actions section.
In this section, admin user can define how much points will be rewarded to the customer.
16 of 26
Reward Points for Magento 2
The system will show the following earning points choices:
Image 18. Available Points for a Shopping Cart Rule
Select the applicable earning points and fill out the corresponding fields:
Field Value
Earn
Choose the form and the number of reward points that the customer will earn after meeting the conditions:
● Fixed amount of points ● % of product price - The percentage of the product price that the customer will
earn as reward points (eg. 10% of product price) ● % of cart value - The percentage of the entire cart price that the customer will
earn as reward points (eg. 5% of cart price)
Amount The amount of points or percentage value of product price or cart value
Discard subsequent rules Yes/No - indicates if the system should stop processing other rules once this rule is satisfied
Points expiration, days The number of days after which earned points will expire after earning, otherwise, leave blank to indicate no expiry
NOTICE In the case of Behavioral rule type, only Fixed amount of points form of reward points is available.
NOTICE The Calculate earned points option doesn’t work for the % of product price option, since shipping is calculated for the cart, not specific products. Also, the % of product price option applies only to the matched products.
17 of 26
Reward Points for Magento 2
If the Behavioral rule type is selected, the system will show the following section:
Image 19. Email Notifications Configuration for a Behavioral Rule Type
Configure email notifications by selecting values for the fields:
● Send notification email - Select Yes or No to enable or disable sending notification email.
If Yes is selected, choose the values for the following fields:
○ Sender - the email Sender (From)
Image 20. Magento senders for notification email
○ Select email template - choose from a list of Magento email templates configured for this extension
Image 17. Choose existing email templates
The following extension specific variables must be available for templates:
18 of 26
Reward Points for Magento 2
● Transaction/Expiration value
● Balance total
Once done, click on the Save Rule button. System will show corresponding “Rule was successfully saved” message.
2.8 Thresholds
Marketing > Exto Rewards Points > Thresholds
The system allows admin users to manage spending thresholds and requirements. Configuration changes are applied globally.
Navigate to the Thresholds form to create or modify existing thresholds.
Image 21. Modifying Spending Thresholds
Fill out the following fields and indicate values when applicable. Leave the fields blank to indicate no limit. All values will be evaluated before a
customer can proceed in redeeming points.
19 of 26
Reward Points for Magento 2
Field Value
Cart Subtotal Shopping cart value threshold to start redeeming points
Cart items qty Minimum number of items in the cart to start redeeming points
Point balance Minimum rewards point balance to start redeeming points
Points amount to apply Minimum number of reward points that the customer can redeem upon checkout
Customer daily spend limit Maximum number of reward points that the customer can redeem per day
IMPORTANT NOTICE
In case of global and local rule value conflict (e.g. cart limits), the global value has priority
Once done with the changes, click on the Save button.
2.9 Viewing the list of Reward Points Transactions
Marketing > Exto Rewards Points > Transactions
Navigate to the Transactions form to view a list of all rewards points transactions.
Image 22. View of Reward Points Transactions
The table contains the following information:
20 of 26
Reward Points for Magento 2
Field Description
Transaction ID
Customer Name Includes customer name and email address
Amount green for reward points earned, red for reward points redeemed
Comment Rule title or admin comment
Expiration Date No date shown means no expiry
2.10 Changing the Settings
Marketing > Exto Rewards Points > Settings
21 of 26
Reward Points for Magento 2
Image 23. Reward Points Setting
Fill out the following fields in the form:
Field Description
Points name Points name as customers will see it on the website
Exchange Rate Base currency unit to points conversion
Calculate earned points Identify how earned points should be calculated.
Pay tax/shipping by points Indicate if it is allowed to pay tax and shipping using reward points.
Send points expiration email
Choose Yes or No to enable or disable sending of email notification. If Yes is selected, choose the values for the following fields: Send before, days - (default:3) indicate days before expiry date for the system to trigger email notification Sender - pick a sender from a list of Magento senders as indicated in image 20 Email template - choose from a list of the extension email templates, pre-configured with an expiration template by default
Reward program explanation text Choose a CMS block. It is displayed in the Rewards Points customer area.
Display cart promotion
Choose between Yes or No to enable or disable cart promotional text shown in the top part of the customer’s shopping cart. Refer to image 27 for sample cart promotional text. If yes, the system will show the additional fields below: (Default Text: “Checkout now and get {cart_points} ({money_value}) points in reward! ” ) Use the parameters cart_points and money_value for your message.
Shopping cart information text
This message will be shown on the customer’s Shopping cart summary section. Refer to image 28 for sample Shopping cart information text. (Default text: “You can spend <b>{available_points} {points_name}</b> with this purchase”) Use the parameters available_points and points_name to create the message that will appear in the shopping cart totals section.
Click on the Save Config button once done.
22 of 26
Reward Points for Magento 2
3. Customer Area
3.1 Viewing My Reward Points
Customers can login to their account to view their existing reward points balance in the My Reward Points section.
Image 24. Customer Area View
The customer’s remaining rewards points are indicated on the top of the page. The table below it contains all of the customer’s reward points
transactions.
The table contains:
● Transaction ID
● Comment
● Value
● Date
● Expiration
23 of 26
Reward Points for Magento 2
3.2 Viewing Orders with Reward Points transactions
Customers can login to the site and navigate to the My Orders section to check orders with reward points transactions.
Customer can see Reward points redeemed and amount refunded to the reward points per order.
Image 25. Customer Area View - Order with Reward Points Redeemed
Image 26. Customer Area View - Order with Reward Points Refunded
4. Shopping Cart
4.1 Using Reward Points With New Order
Customers can login to their account and use their reward points balance once they place an order.
If the Display cart promotion setting is On and configured in step 3.10, then the configured notification text is displayed at the top of the
shopping cart.
24 of 26
Reward Points for Magento 2
Image 27. Sample promotional text shown above the shopping cart details
On the Summary section of the cart, customer will see the configured Shopping Cart information text showing the available reward points that
he can redeem for the specific order.
Image 28. Shopping cart reward points information
To apply reward points, customer must indicate a value less than or equal to the indicated available reward points.
25 of 26
Reward Points for Magento 2
Once the customer clicks the Apply button, the system will show a success message along with the following fields, whenever applicable:
● You earn xx - earned reward points if a particular earning rule was triggered including currency equivalent
● You apply xx - reward points applied including currency equivalent
Customer has the option to Cancel reward points redemption.
If the customer enters a value greater than the reward points balance, the system will show an error message.
Image 29. Shopping cart reward points insufficient balance error message
26 of 26