AvielanApps

Documentation

Points app (working title)

A Japan-focused loyalty app for purchase rewards, checkout discounts, and signup bonuses — with tax-exclusive earn calculations.

Official app name is TBD. Labels will be updated before launch.

Overview

This loyalty app awards points based on purchases and lets customers redeem them as checkout discounts.

The program is off right after install. Save your settings, then turn Program on to start earning and redeeming.

Features

All plans

  • Program on/off
  • Purchase rewards (tax-exclusive earn rate)
  • Checkout discounts with points
  • Expiration, lot tracking, and auto-expiry
  • Signup (enrollment) bonus points
  • Customer list and detail (balance, history, manual adjustments, release reservations)
  • Storefront UI (floating menu embed, cart redeem block, and more)

Standard and above

  • Campaigns (multiplier or fixed points, with period and conditions)
  • Bulk import/export via CSV / Excel

Pro

  • POS sync (e.g. Smaregi via Shopify Flow)
  • Shopify Flow (change-points action / points-changed trigger)

Getting started

  1. Install the app from the Shopify admin.
  2. Open Settings → Basic settings and save earn rate, point value, award timing, expiration, and signup bonus.
  3. Turn Program on in the settings hub (this prepares the points discount).
  4. Under Settings → Storefront, enable the theme app embed “Points menu (bottom-right)” and save. Optionally add the cart redeem block.
  5. As a logged-in test customer, apply points in the cart and confirm the checkout discount.
  6. Fulfill a test order and confirm points were awarded on the customer detail page.
  7. Optionally configure campaigns (Standard+), CSV bulk tools, and Flow / POS (Pro).

How points are earned

When an order is created, an award is reserved. Points are actually granted when fulfillment completes. Earn is calculated from the product subtotal converted to tax-exclusive amounts; shipping is excluded.

  • Order created: reserve the award; finalize any redeem reservation against the balance.
  • Order fulfilled: grant reserved points (immediately if delay days is 0, otherwise later). Partial fulfillment does not award; full fulfillment awards in one batch.
  • Order paid: if “hold until paid” is on, unlock awarding after payment confirmation.
  • Customer created: grant the signup bonus.
  • Order cancelled: reverse awards and return redeemed points.
  • Refund created: reverse awards and return redeemed points proportionally by amount.
  • Order edited: recalculate only awards that have not been granted yet.

How points are redeemed

  1. The customer enters points in the storefront (floating menu or cart block).
  2. The app creates a reservation and updates customer metafields (balance is not reduced yet).
  3. At checkout, a Shopify Function applies an order discount (capped so it does not exceed the subtotal).
  4. When the order is created, the balance is reduced and a redeem history entry is written.
  5. Cancelling the reservation clears it. There is no dedicated abandoned-cart webhook, so unused reservations expire after about 24 hours. Merchants can also release them from the admin.

Key settings

Program on/off
Master switch. While off, new awards, redemptions, and signup bonuses do not run.
Assumed consumption tax rate
Tax rate used to convert tax-inclusive amounts to tax-exclusive (e.g. 10%).
Earn rate (tax-exclusive)
Percent of tax-exclusive amount awarded. Example: 1% on a ¥1,100 tax-inclusive item at 10% tax ≈ 10 points.
Point value
How many points equal how many yen of discount when redeeming.
Minimum redeem unit
Increment for redeemable points.
Days after fulfillment
Delay before awarding after fulfillment. 0 means immediately after fulfillment.
Hold until paid
If an order is fulfilled before payment (e.g. COD), wait for payment confirmation before awarding.
Validity days from award
0 means no expiry. Otherwise points expire after the configured days.
Expiration mode
Per award lot / refresh all on last purchase / refresh all on last award.
Signup bonus
Bonus points when joining the program, plus expiry and history label.
Allow redeem on first subscription order
Allow points discounts on carts that include subscription products (separate from earn rules).
Include guest checkouts
Also award for guest orders by linking the customer via email, etc.
Cancel return mode
Return as a new award (uses basic expiry) or restore original lots (keeps original expiry; expired lots are not restored).
Stack with other discounts
Whether points discounts can combine with product/order/shipping discounts. The other discounts must also allow combining.

Plans

Three plans: Free, Standard ($24.99/mo), and Pro ($79.99/mo). Each has a monthly included-order cap. Optional overage billing can keep processing after the cap; if overage is off, new points processing stops for the rest of the month once the cap is hit.

  • Free: core earn/redeem, history, expiry, signup, storefront (10 orders/mo)
  • Standard: plus campaigns and CSV bulk tools (1,000 orders/mo)
  • Pro: plus POS / Flow (3,000 orders/mo)

Important notes

  • Nothing runs while the program is off.
  • Awards are driven by fulfillment. Unfulfilled or only partially fulfilled orders do not earn. Split-fulfillment proportional awarding is not supported.
  • Earn/redeem assume JPY. Non-JPY orders are ignored.
  • Edits to already-awarded orders do not add/remove awards (only ungranted reservations are recalculated).
  • “Allow on first subscription order” affects redeem only; earn still follows normal rules.
  • Unused cart reservations auto-clear after about 24 hours.
  • Smaregi sync needs Shopify Flow setup in addition to the in-app switch.
  • There is no Customer Account UI extension or native Shopify POS UI extension yet (in-store sync is via Flow).

Support

For setup or issues, use Contact or email apps@avielan.co.jp.

See the privacy policy for how personal data is handled.