Configuration settings
To configure the Reward Points extension, navigate to Stores -> Settings -> Configuration -> Mirasvit Extensions -> Reward Points.
General settings
The general settings control the foundational behavior of the rewards program, including how points are managed and approved.
-
Point unit name: define the name that represents the points across the store, such as "Reward Points" or "Loyalty Coins." This will be used throughout the store interface wherever points are displayed.
-
Reward points expire after, days: set the number of days after which unused points will expire. If set to 0, points will not expire, allowing customers to accumulate points indefinitely.
-
Delay usage of reward points for, days: this option allows you to delay the ability for customers to spend their earned points by a certain number of days. This is useful for ensuring that points are not immediately available in cases of returns or cancellations. Setting this to 0 will make points available for use instantly after they are earned.
-
Redirect to "My Reward Points" section after login: when enabled, after logging into their account, customers will be automatically redirected to the "My Reward Points" section, helping them quickly view their balance and recent activity. If disabled, customers will be redirected to the default homepage after login.
Approval conditions
Define when points are credited to customers' accounts based on order actions such as invoicing, shipping, or order status.
-
Approve earned points on invoice: when enabled, reward points will only be credited to the customer's account once an invoice is generated for the order. This ensures that points are awarded after payment is processed.
-
Approve earned points on shipment: similar to invoice-based approval, this option credits points only after the order is marked as shipped, which is helpful in ensuring customers receive points after their order is physically fulfilled.
-
Approve earned points if order has status: you can select specific order statuses (e.g., complete, processing) that must be met before the points are approved. This gives control over when customers can actually use their points, ensuring points are not misused in pending or cancelled orders.
Refund handling
Set rules for canceling or restoring points if an order is refunded.
-
Cancel points after refund: automatically cancels any points that were earned from an order if that order is later refunded. This prevents customers from keeping points they should no longer have due to the refund.
-
Restore points after refund: automatically restores any points that were spent on an order if that order is refunded. This option ensures customers do not lose points on orders that are returned or refunded.
Rules tax configuration
Decide if taxes, discounts, and shipping charges are considered when calculating points earned and spent.
-
Include discount for earning rules: determines whether discounts should be included when calculating how many points a customer earns. This applies to Cart Rules, where points may be calculated based on the total value of the cart. If enabled, discounts will reduce the total eligible for earning points.
-
Include tax for earning rules: includes taxes in the calculation of earned points. If enabled, the total points awarded will reflect the tax-inclusive value of purchases.
-
Include tax for spending rules: when spending points, this setting allows taxes to be included in the amount eligible for point spending. For example, if taxes are included, points can be applied to cover the taxed portion of the order as well.
-
Apply spending points discount after tax: this setting determines whether points are applied before or after taxes in the checkout process. The configuration must align with the store's tax settings to ensure correct calculations.
Shipping charges
Control whether customers earn and can spend points on shipping fees.
-
Earn points from shipping charges: when enabled, customers can earn reward points on the cost of shipping. This can incentivize customers to place larger orders, as they will benefit from the additional points earned on shipping fees.
-
Spend points on shipping charges: allows customers to use their reward points to cover shipping costs, offering more flexibility in how points can be redeemed.
Notification settings
Configure how and when customers receive notifications about their reward points, ensuring they are informed about key events such as balance updates or point expiration.
-
Email sender: specify the email address from which all reward point notifications will be sent. Ensure this is a recognizable address to avoid emails being marked as spam.
-
Balance update email: select the email template used to notify customers whenever their points balance updates.
-
Transaction inactive email: choose the email template used to notify customers when there is a delay in point usage, such as when there is a pending approval or delay period for points.
-
Points expire email: define the email template used to inform customers when their points are about to expire. This helps remind customers to use their points before they lose them.
-
Send notification before points expire: set the number of days before points expire to send a reminder email to customers. This is a useful way to encourage customers to return to the store to use their points before expiration.
Tiered rewards program
Use this section to create a tier-based loyalty program where customers are rewarded for reaching different tiers based on their earned points or total spend.
-
Switch between tiers based on: choose the criteria for switching between tiers (e.g., sum of earned points, sum of spent $).
-
If sum of spent $ is selected in Switch between tiers based on: additional options become available to refine how the total spent is calculated for tier upgrades:
-
Use orders in status: select which order statuses (e.g., "Completed", "Processing") should be included in the calculation of total spent. This ensures that only fully processed orders count toward tier progression.
-
Include tax: enable this option if you want the tier calculation to include taxes from purchases. If disabled, only the pre-tax amount is used.
-
Include discount: determine whether discounts applied to orders (e.g., promo codes) should be considered in the tier calculation. This gives a clearer picture of what the customer actually paid, after all discounts.
-
Include shipping: enable this option if you want shipping fees to be included in the total spent for tier calculation. This ensures that shipping costs contribute to tier progression, incentivizing customers to make larger purchases with higher shipping charges.
-
For tier calculation take into account only last N days: define the period (in days) over which customer activity is tracked for tier calculation. For example, if set to 90 days, only purchases or points earned within the last 90 days are considered. This rolling window ensures that customers must remain active to maintain their tier status.
Let's take a look at this example:If the period is set to 90 days and a customer spent in general $1500 but in the past three months spent only $500, the system will take into account only $500. So if "Gold" tier requires $1000 spent to reach the tier, they may need to spend an additional $500 within the same time frame to reach "Gold" tier.
Similarly, if the system is based on points, the customer may have earned 1500 points within the last 90 days but used some of them, leaving them with 500 points. Regardless of how many points remain, their tier level is determined by the total points earned during the defined period.
This encourages customers to return to the store and make a purchase so as not to lower their tier.
-
-
Automatically move customer to a lower tier if they do not meet minimum tier requirements: this option enables automatic tier demotion if a customer fails to meet the required spending or point accumulation within the specified period. For example, if the customer does not make purchases or earn enough points within the 90-day window, they will be downgraded to a lower tier. This ensures that tiers reflect ongoing customer activity and engagement.
Referrals
This section manages the settings for your store's referral program, where customers can earn points by referring friends.
-
Enable referral system: enable or disable the referral system.
-
Invitation email template: select the email template used to send referral invitations. This is the message that friends will receive when invited to join the store.
-
API invitation email template: choose the email template used when sending referral invitations via the API.
-
Referral invitation message: a message displayed in the "My Referrals" section for customers inviting friends.
Frontend display options
This section controls how reward points are shown to customers on the storefront, helping improve visibility and transparency.
-
Checkout notification: display a notification when the customer has no points available for checkout. Customize the message as needed.
-
Enable rewards logo: display a custom logo for the rewards program on the frontend.
-
Rewards Logo: allows you to upload the logo that will be displayed on the frontend
Customer menu
Define how and where customers can view their rewards balance and points information.
-
Show rewards points menu on frontend: display the Reward Points menu in the Magento frontend.
-
Show pending transactions in customer account: display orders with pending statuses in the "My Reward Points" page of the customer's account.
-
Show expiring points in customer account: display the expiration date of points in the customer’s account.
-
Show points expiring in N days: set the number of days before showing points expiring in the customer’s account.
-
Show rewards points menu for customer groups: exclude selected customer groups from the Reward Points program.
Category and product page
Control whether and how reward points information is shown on category and product pages to inform customers about point-earning opportunities.
-
Show rewards points on category pages: display Reward Points information on category pages as well as product pages.
-
Show points on product pages: show the approximate points a customer will earn for purchasing a product.
To display points on product and category pages, you should also have cart rule with option "Is show on the product page" set to yes.
-
Display points as currency equivalent: display points earned for a product as their approximate money equivalent based on spending rules (this is an estimate and doesn't include cart-specific conditions).
-
Show maximum points for configurable products: display the maximum number of points a customer can earn on configurable products (calculated using options with the highest value).
-
AddToAny code: use "addToAny" for social sharing in the referral widget by pasting the code snippet here.
Advanced settings
Advanced settings give you additional control over how points are calculated and displayed, as well as the ability to create custom reward rules.
-
Round earning points down: choose whether to round earned points to the nearest lower or higher number.
-
Custom behavior events: define custom behavior rules using the format: rulecode, rulename. Refer to Custom Behavior Events for more details.
-
Force apply styles: add extension-specific styles to the page, overriding theme settings if necessary.