Pointz for Craft CMS

Installation

Requirements

  • Craft CMS 5.3+
  • Craft Commerce 5.0+
  • PHP 8.2+

Install

composer require justinholtweb/craft-pointz
php craft plugin/install pointz

Nothing happens until you say so

Pointz installs one disabled earning rule per store, called Points on every order. Adding a loyalty plugin must never start handing out points to a live store before anyone has looked at the numbers, so nothing is awarded until you open Pointz → Earning rules, set a rate and switch it on.

The five-minute setup

  1. Pointz → Settings → Redeeming: set Points per unit of currency. The default of 100 means 100 points are worth 1.00 in your store's currency. This single number is the exchange rate for everything else, so decide it before anyone earns anything — changing it later re-prices every balance in the store.
  2. Pointz → Earning rules: open the seeded rule, set the rate (1 point per unit spent is the usual starting place), and switch it on.

  3. Put a balance somewhere the customer can see it:

    {% if currentUser %}
    <p>You have {{ craft.pointz.formatted(craft.pointz.balance()) }}.</p>
{% endif %}

  4. Add the redemption form to your cart or checkout template — see Usage.

  5. Schedule the sweep, if you are going to expire anything:

    php craft pointz/sweep/run

    Nothing expires because a date passed. It expires because that ran.

Permissions

Two permissions, both under Pointz in the user group settings:

  • View balances and the ledger — the Pointz section, the order panel, and every read-only screen.
  • Grant and deduct value — nested under the first one. Moving a balance by hand, issuing store credit against an order, and rebuilding a balance from the ledger.

Manage earning rules is separate: writing a rule that awards double points is a commercial decision, not a support one.

Upgrading from WooCommerce

Pointz has no importer, because a WooCommerce points log has no lots in it — only a running total. The honest migration is:

  1. Export each customer's current balance from WooCommerce.
  2. Grant it with pointz/grant/to-user, or in bulk with a short script calling Plugin::getInstance()->getGrants()->grantMany().
  3. Leave the history behind. It stays readable in WooCommerce, and Pointz's own ledger starts clean on a date you can point to.

Granting a balance under one batch ID means a mistake in the export can be undone in one command.