Skip to main content
Version: 2.0.0

Reward Points

Reward Points adds a loyalty points system on top of yStore: customers earn points for placing orders, subscribing to the newsletter, registering an account, or other configurable behaviors, and can spend those points as a discount at checkout. Store staff manage everything — earning rules, point balances, and per-customer history — from a dedicated CP section.

Key features​

  • Configurable earning rules for two behaviors: order-based (points per currency unit spent, or a flat amount for completing an order) and customer-based (newsletter signup, birthday gift, registration, inactivity, product review).
  • Rules can be restricted by date range and customer group, and order-based rules can be customized per product.
  • Customers redeem points as a checkout discount, with a slider to choose how many points to spend (or a "maximize discount" toggle).
  • A 5-tier loyalty program (Beginner, Bronze, Silver, Gold, VIP) based on accumulated points, with automatic tier downgrade support.
  • Automatic point refunds when a completed order is canceled/refunded, and automatic email notifications when points are earned.
  • CP dashboard, points/history/orders overviews, and console commands for bulk import and resetting point data.
  • 5 MCP (Model Context Protocol) tools for balance lookup, history, rule listing, order point preview, and adding/deducting points — requires the PRO edition license for writes.

Requirements​

  • The yStore core plugin, since Reward Points extends the shared BasePlugin base class and hooks into checkout, order, and customer events.
  • To use the MCP write tool (rewards_add_points), the MCP plugin and a PRO edition license.

Installation​

Install through Composer, using the credentials granted by your yStore license:

composer require yui/craft-reward-points

Then enable the plugin from Settings → Plugins in the Craft control panel and continue with Settings.

Use cases​

See Use Cases for setting up earning rules, configuring the loyalty program tiers, letting customers redeem points at checkout, and reviewing point history, and Rules for the full reference on rule types, point calculation, and rounding.

Developer notes​

See Developer / API for the Twig craft.rewardpoints variable, CP/site routes, events fired for point earning and refunds, the MCP tools, and the console commands used for import and data resets.