Skip to main content

Loyalty Programs

docs image

Loyalty Programs

Accumulating and using loyalty points

Loyalty programs allow you to store points on users, which can accumulate based on certain conditions. These points can then be used as either a payment type, or to trigger certain promotions. This document describes setting up a loyalty program, along with its options.

Loyalty programs are managed in Admin Suite, under Promotions -> Loyalty Programs.

Authorization

In order to be able to access this chapter, you need the LoyaltyPrograms permission. Check the loyalty related functionalities for more details.

Program configuration

We currently have two loyalty program handlers;

  • LOYALTYAPI
  • EVALOYALTY

LOYALTYAPI

This handler gives you the most flexibility, but is also the hardest to set up, as it requires you to have a third-party to store loyalty points, and a custom integration. Read more here.

EVALOYALTY

This handler stores your points in EVA. We support withdrawals, payments (using points), and points awarding in EVALOYALTY, we also support this on production environment. We don't want to be a bank, so we can't store actual monetary value. This is why EVALOYALTY does not support payments on production environments.

Expiration span

The expiration span dictates how long loyalty points will be usable before expiring. There are 5 options;

OptionDescription
DefaultNo expiration date.
CustomExpire along a custom interval. Selecting week and entering 10 will result in expiration after 10 weeks.
Expire end of yearPoints will expire at the end of the year.
Expire end of monthPoints will expire at the end of the month.
Expire set datePoints will expire on the given month and day in the year when the points were issued. If the given date falls BEFORE the issued date, they will expire the following year.

Expire set date comes with an additional field; Leniency days. This dictates the minimum amount of days required between when the points are issued to when they expire.

Note

Expiration span only kicks in after the pending period has concluded.

Pending points

Some retailers want to have a certain pending period before points are issued.

OptionDescription
DefaultNo pending period.
CustomCustom pending period. Selecting week and entering 10 will result a pending period of 10 weeks.
Pending Return PeriodPoints will remain pending until after the return period expires. Same value as setting Returnable:InvoicedDays which is one of the settings available that influence returns for more.

Subscribing users to a loyalty program

In order to subscribe users to a loyalty program, set up a subscription, linking it to your desired loyalty program.

Based on role permissions, each user may have different rights on what can be done within the loyalty module and frontend behaviour. Permissions are managed from the Roles and rights chapter namely, from the functionalities card of a users role.

The following table provides a list of those permissions and the impact each one has on the users rights:

Show loyalty related functionalites
Functionality nameScope when functionality is not ticked
LoyaltyProgramsThe scope on what a user can do using the loyalty programs chapter.
BlockUserSubscriptionThe ability to block a subscriber from accumulating or using loyalty points from a specified loyalty program.
BlockUserSubscriptionThe ability to unblock/reverse a blocked subscriber from accumulating or using loyalty points from a specified loyalty program.
DepositLoyaltyPointsThe ability to deposit loyalty points to any users balance.
ApplyLoyaltyDiscountThe ability to apply a discount that is grounded upon loyalty benefits.