Skip to content

Loyalty

Menu: Commerce -> Loyalty
Deep link: /_Admin/commerce/loyalty?SiteId={siteGuid}
Tab deep links: ...&name=membership|member|earnPointsConfig|redeemPointsConfig

Configure membership tiers (Membership), view members with points and tiers, and set earn points and redeem points rules. Data is stored in Commerce settings.earnPoint / settings.redeemPoint and membership tier tables; carts can enable points deduction, orders show points earned. Script APIs: k.commerce.loyalty, membership.

How to Open

  1. In the Edit menu, enable Commerce -> Loyalty (and the parent Commerce group).
  2. Open Commerce -> Loyalty in the left sidebar.

Four tabs at top; switching updates URL query name for bookmarks and deep links.

Membership Tiers

(default tab)

Define sellable membership tiers: name, validity period, subscription purchase, auto-upgrade by rules, etc.

Column / ActionDescription
NameTier name
DescriptionDescription text
Tierpriority; higher number = higher tier (see UI tooltip)
Durationduration + durationUnit (e.g. year/month)
PriceShown when Subscribe (allowPurchase) is checked; currency is site default
Create membership tierOpens create/edit dialog
EditRow pencil
Batch deleteSelect → Delete (with confirmation)
Membership tiers tab: tier list and create button

Membership Tier Dialog

Create / Edit share EditForm (edit fetches detail with id).

Create membership tier dialog: name, upgrade method and conditions
FieldDescription
NameRequired
DescriptionMultiline text
Tierpriority integer
DurationMembership validity duration and unit
Upgrade methodSubscribe: purchasable, enter price; Upgrade by rules: configure customer dimension Condition (AND/OR), at least one condition required
Custom dataKeyValueEditor key-value pairs

Save refreshes the tier list.

Members

View customers registered as members (linked to customers): current tier status, points balance.

Column / ActionDescription
NamefirstName / lastName
Email / Phone
MembershipMembershipStatus: tier name tag; Expired when past end; Non-member when no tier
PointsCurrent available points
SearchKeyword; press Enter to query
DetailsRow eye icon → member details dialog
Pagination10 rows per page by default
Members tab: list, tier status and points

Member Details Dialog

SectionDescription
SummaryContact, email, phone, current membership status, start/end time, points
Membership details tabPurchase/change history; Change tier, Renew (requires loyalty · edit)
Points history tabPoints ledger; Manual top-up, Manual spend with notes
Member details dialog: summary, membership details and points history

Point change types include: manual top-up/spend, order reward, order deduction, login reward, etc.

Earn Points

Configuration written to settings.earnPoint; bottom Save (saveSettings); keyboard shortcut save supported.

Earn points: validity, login and order rules
SectionDescription
Reward points validityactiveDuration + unit: points valid for this duration from earn date
Login earn rulesMultiple rules: fixed points per period (day/week, etc.) + logged-in user conditions; add/delete; click Done after edit
Order earn rulesMultiple rules: fixed points or percentage of paid order amount + paid order conditions

Redeem Points

Configuration written to settings.redeemPoint; bottom Save.

Redeem points: exchange rate and order deduction rules
SectionDescription
Points to moneyexchangeRate: N points = 1 unit default currency (UI example shows 1 currency unit)
Points deduction rulesMultiple rules: points deduction at checkout, fixed points or percentage of amount + paid order class conditions

When cart "Use points" is checked, calculation uses this rate and rules (see points deduction on carts same page).