Magento 2 Reward Points
A comprehensive guide to installing, configuring, and managing the Magento 2 Reward Points extension by Meetanshi. This extension allows you to create a robust loyalty program, boosting customer retention and encouraging repeat purchases through points for purchases, referrals, social sharing, and tier-based rewards.
Extension Configuration
To configure the extension, log into the Magento 2 admin panel and navigate to Stores > Configuration > Meetanshi > Reward Points. The configuration is divided into multiple sections as detailed below.
General
- Enable Module: Set to Yes to enable the Reward Points module globally.
- Point Label (Singular): Enter the label for a single reward point (e.g., "Point", "Coin").
- Point Label (Plural): Enter the label for multiple reward points (e.g., "Points", "Coins").
- Point Label Position: Select whether to display the point label before or after the point value.
- Zero Point Label: Enter the label to display when a customer has a zero point balance.
- Show Point Icon: Set to Yes to display a visual icon next to the points.
- Reward Point Icon: Upload the image to be used as the reward point icon.
- Maximum Available Point Balance: Set the maximum point balance a customer can accrue. Set to 0 for unlimited points.
- Redirect to Reward Points After Login: Set to Yes to automatically redirect customers to their reward points dashboard upon logging in.
Landing Page
- Choose Landing Page: Select the CMS page you want to use as the dedicated reward points landing page.
- Display on Footer Link: Set to Yes to add a link to the reward points landing page in the website footer.
- Landing Page Label: Enter the text for the footer link. (Depends on: Display on Footer Link being enabled).
Highlight
- Show in Cart: Choose whether to display potential point earnings or highlight messages on the shopping cart page.
- Show on Checkout: Set to Yes to display point earning potential during the checkout process.
- Show on Product Pages: Set to Yes to highlight how many points a customer can earn by purchasing a specific product.
- Show on Categories: Set to Yes to show point highlights on product listing/category pages.
- Show for Guests: Set to Yes to display reward point highlights to non-logged-in guest users, encouraging them to register.
- Highlight Text Color: Select the specific text color used for the reward points highlight messages across the frontend.
Earning
- Rounding Method: Select how earned points are rounded (e.g., Normal, Round Up, Round Down). Note: This is ignored if Advanced → Round Down Points is set to Yes.
- Earn from Tax: Set to Yes if you want customers to earn points based on the tax amount of their order.
- Earn from Shipping: Set to Yes if you want customers to earn points on the shipping fees.
- Point Refund: Set to Yes to automatically deduct earned points from the customer's balance if their order is refunded.
- Point Holding Days: Enter the number of days earned points are placed on hold before they become available for use.
- Earn from Coupon Orders: Set to Yes to allow customers to earn points even on orders where a discount coupon was applied.
- Calculation Type: Choose the basis for calculating earned points.
- Earning After Invoice: Set to Yes so points are only awarded after the order has been invoiced.
- Points Expired After Days: Enter the number of days after which earned points will expire. Set to 0 if points should never expire.
Spending
- Min Points per Order: Set the minimum number of points a customer needs to spend in a single order.
- Discount Label: Enter the label displayed for the point discount on the frontend (e.g., "Reward Points Discount").
- Max Points Type: Select how the maximum spending limit is determined (e.g., fixed amount or percentage of grand total).
- Max Points per Order: Enter the maximum number of points a customer can spend on a single order.
- Spend on Shipping: Set to Yes to allow customers to use their points to cover shipping costs.
- Restore Spent on Refund: Set to Yes to restore the points spent by the customer if their order is refunded.
- Use Max by Default: Set to Yes to automatically apply the maximum allowable points during checkout.
- Spend from Coupon Orders: Set to Yes to allow customers to spend points on orders where they also applied a discount coupon.
- Apply After Tax: Set to Yes to deduct the discount after tax is computed. Set to No to reduce the taxable base before tax calculation (requires Sales → Tax → Apply Customer Tax = After Discount).
- Include Tax in Discount: Set to Yes to allow the point discount to cover the tax amount.
Display
- Show on Top Links: Set to Yes to show the customer's point balance in the header top links.
- Hide if Zero: Set to Yes to hide the point balance from the top links if it is zero.
- Show on Minicart: Set to Yes to display the point balance within the minicart dropdown.
- Show on Cart: Set to Yes to display the point balance summary on the shopping cart page.
- Show as Currency: Set to Yes to display the equivalent currency value of the points alongside the point balance.
- Show Max Points for Configurable Products: Set to Yes to display the maximum possible points a customer could earn when viewing configurable products.
Email Notifications
- Enable Notification: Set to Yes to enable all reward points email notifications.
- Subscribe by Default: Set to Yes to automatically subscribe new customers to reward points emails.
- Email Sender: Select the store identity (e.g., General Contact, Sales Representative) used to send reward points emails.
- Update Balance Email Template: Choose the template used when a customer's point balance changes.
- Expiration Warning Email Template: Choose the template used to warn customers about expiring points.
- Tier Upgrade Email Template: Choose the template used to congratulate customers on a tier upgrade.
- Tier Downgrade Email Template: Choose the template used to notify customers of a tier downgrade.
- Birthday Email Template: Choose the template used for sending birthday reward points.
- Expiration Reminder Days: Enter a comma-separated list of days before expiration to send reminders (e.g., 30,7,1).
Social Sharing
- Facebook Show Button: Set to Yes to display the Facebook share button to earn points.
- Facebook Show Count: Set to Yes to display the share counter alongside the Facebook button.
- Facebook App ID: Enter your Facebook App ID to properly integrate the sharing functionality.
- Twitter Show Button: Set to Yes to display the Twitter share button to earn points.
- Pinterest Show Button: Set to Yes to display the Pinterest share button to earn points.
- Pages to Display: Select the specific store pages where the social sharing buttons should appear.
- Min Seconds Between Actions: Set the minimum time interval required between social actions for a customer to earn points.
Referral
- Invitation Email Template: Select the template used when customers send referral invitations to friends.
- API Invitation Email Template: Select the template used for referral invitations sent via the API.
- Default Refer URL: Enter the default landing page URL for incoming referral traffic.
- URL Key Mode: Choose how the unique referral URL key is generated for each customer.
- Code Prefix: Enter an optional prefix that will be prepended to auto-generated referral codes.
- Default Invitation Message: Enter the default message text pre-filled when customers send an invitation.
- AddToAny Code: Enter your AddToAny script code if using it for extended social sharing of referral links.
Tier / Milestone
- Enable Milestone: Set to Yes to enable tier-based rewards and milestones.
- Switch Based On: Choose the metric used to determine tier upgrades.
- Earn Point Source: Select which types of earned points qualify towards tier progression.
- Earning Period Days: Specify the rolling period in days for evaluating a customer's tier requirements.
- Auto Demote: Set to Yes to automatically move customers to a lower tier if they fail to meet the requirements within the earning period.
- Progress Background Color: Select the background color for the frontend tier progress bar.
- Progress Color: Select the active fill color for the frontend tier progress bar.
- Email on Tier Change: Set to Yes to send customers an email notification when their tier changes.
Advanced
- Round Down Points: Set to Yes to force all point calculations to round down. Note: This overrides the standard Rounding Method set in the Earning section.
- Custom Behavior Events: Define custom events for earning points. Enter one entry per line in the format:
rulecode,Rule Name.
Marketing & Operations
Beyond the standard configuration, the Reward Points extension offers advanced management options under Marketing > Reward Points and Marketing > Reports & Data. These sections allow administrators to granularly control earning and spending rules, manage tiers, manually adjust customer balances, and analyze performance.
Transactions
(Found under Marketing > Reward Points > Transactions) Manage and manually adjust individual customer point balances.
- Customer ID: Enter the numeric ID of the customer.
- Points: Enter a positive integer to add points or a negative integer to deduct points.
- Comment: Internal or customer-facing note detailing the reason for the transaction (Max 500 characters).
- Points Expire After (days): Set a specific expiration for this transaction. Enter
0to use the global default. - Notify Customer: Choose whether to send an email notification to the customer regarding this transaction.
Earning
Earning Rate
- Status: Set to Active or Inactive.
- Websites & Customer Groups: Restrict the earning rate to specific storefronts or customer groups.
- Priority: Determines the order of execution. Lower numbers have higher priority (0 is the highest).
- Money Spent ($): The currency step value (e.g., $10).
- Earning Points: The number of points rewarded for every "Money Spent" step.
- Min Order Total: Minimum order amount required to qualify for this earning rate. Leave empty for no minimum.
Catalog Rules
- Rule Information: Define Rule Name, Description, Status, Websites, Customer Groups, Priority, and active Date ranges.
- Conditions: Set specific product attributes or category conditions for when the rule applies.
- Action Type: Choose how points are awarded: Fixed Points, Points per Price Amount, or Points per Profit Amount.
- Points (X): The number of points to award.
- Money Step (Y): Required when Action Type is not Fixed. Earn X points for every Y currency spent.
- Max Points per Order: Maximum points a customer can earn via this rule (0 = unlimited).
- Stop Further Rules Processing: Discard subsequent rules if this rule is applied.
Shopping Cart Rules
- Rule Information & Conditions: Define basic rule information and cart-based conditions (e.g., Subtotal, Shipping Country).
- Show on Product Page: Choose whether to display the potential points on relevant product pages.
- Action Type: Choose Fixed Points, Points per Price Amount, or Points per Item Quantity.
- Points (X) & Money/Qty Step (Y): Set the reward points ratio.
- Max Points per Order: Limit the maximum points earned via this rule.
- Product Page Notification Message: The text displayed on product pages when the rule applies. Supports
{{points}}placeholder.
Behavior Rules
- Event Code: Select the customer behavior that triggers the reward (e.g., Customer Registration, Newsletter Sign-up, Product Review).
- Frontend Display Name & Messages: Set names and messages shown in the points history and email notifications.
- Action Type & Points: Set how points are calculated (Fixed or dynamically).
- Caps & Limits: Define limits on how many points can be earned per day, month, year, or lifetime for this specific behavior.
Spending
Spending Rate
- Status, Websites, Customer Groups, & Priority: Standard rule constraints.
- Points to Spend: Number of points the customer must redeem.
- Currency Amount ($): The discount amount awarded for redeeming the above points.
- Min Points Per Order: Minimum points a customer must have before this rate becomes available.
Shopping Cart Rules (Spending)
- Spending Style & Action: Define how points can be spent in the cart.
- Points Step (X) & Discount Action: Set the redemption increment (e.g., every 100 points).
- Discount Amount: The value of the discount applied per step.
- Min/Max Points: Set minimum required points to spend or maximum allowed points to spend per order.
- Apply to Shipping: Choose whether the points discount can cover shipping costs.
Referral Rules
- Rule Information & Conditions: Define constraints for the referral program.
- Referrer Points: Points awarded to the existing customer who sent the referral.
- Referee Points: Points awarded to the new, referred customer.
- Referee Discount & Discount Type: Additional discount (Fixed or Percentage) granted to the referred customer on their first purchase.
- Max Invitations: Limit the number of successful referrals a single customer can make (0 = unlimited).
Tiers
(Found under Marketing > Reward Points > Tiers) Manage loyalty levels and milestone benefits for your customers.
- Tier Name, Description & Image: Visual and textual identification for the tier.
- Minimum Points / Orders: Thresholds a customer must reach to qualify for this tier.
- Email Template: Specific email sent when a customer upgrades to this tier.
- Earning Bonus (%): Additional percentage bonus on all earned points (e.g., 10%).
- Behavior Bonus Points: Extra flat points added whenever a behavior rule is triggered.
- Spending Discount (%): Points discount when redeeming. The customer needs fewer points to get the same discount value.
- Free Shipping: Grant free shipping as a tier perk.
- Linked Cart Rule ID: Optionally link a Magento Cart Price Rule to automatically apply specific discounts to tier members.
Reports & Data
(Found under Marketing > Reports & Data)
- Points Earned: Detailed grid displaying a history of all points earned by customers.
- Points Spent: Detailed grid displaying a history of all points redeemed or deducted.
- Import / Export: Tools to migrate point balances via CSV, useful for initial setup or synchronizing with external CRM systems.