For the complete documentation index, see llms.txt. This page is also available as Markdown.
loyaltyLoyalty Managerredemption scheduleredemption rulesrequired field

Redemption rules

This topic describes the mandatory and optional rules for point redemption schedules.

In the same way as the Collection, a Redemption Schedule must be equipped not just with a type but with additional rules. Certain rules apply only to certain redemption types, while others apply to all types. Some rules are mandatory; others are optional. In the following table the mandatory rules appear in bold font. Some rules may be repeated in the redemption schedule (for example, include several Customer Groups), while others may appear only once (e.g. “Minimum Purchase” for PP).

Complete list of the redemption rules (click to expand)

Rule
Applicable type
Mandatory
Occurrence
Possible values
Default
Description

Reward value per point

$D, O, $C

Yes

Multiple, no duplicates

Pair of: # of points reward value

100/$10

Applies redemption schedule: e.g. \$10 off for 100 points, $20 off for 200 points etc.

Reward value per point

%D, %C

Yes

Multiple, no duplicates

Pair of # of points reward value (%)

100/10%

E.g. 10% off for 100 points, 20% off for 200 points etc.

Reward value per point

RI

Yes

Multiple, no duplicates

Triplet of: # of points# of reward items% discount

10/1/100%

E.g., for 10 points, 1 reward item at 100% discount

Reason code

$D, %D, $C, %C

Yes

Single

Any Discount Reason Code

A Discount reason code type, which is automatically applied to every discounted item. The reason code must not be used for any other discount

Offset Charge/NI Item code

O, OC

Yes

Single

Non-inventory Item or Charge lookup code

A negative charge which will offset the transaction subtotal by the reward value

Applies to the same incentive group as Collection

All types

No

Single

Boolean

Enabled

If selected, applies only to the same incentive groups as the collection schedule in the loyalty program

Include incentive group(s)

All types

No

Multiple, no duplicates

Any incentive item group

Applies the reward only to the items from the selected item groups

Exclude incentive group(s)

All types

No

Multiple, no duplicates

Any incentive item group

Does not apply the reward to the items in the selected item groups

Include customer group(s)

All types

No

Multiple, no duplicates

Any customer group

Applies the reward only to the customers from the selected customer groups

Exclude customer group(s)

All types

No

Multiple, no duplicates

Any customer item group

Does not apply the reward to the customers in the selected item groups

Redeem on Backorders

All types

No

Single

Boolean

Enabled

Specifies if the points can be redeemed on picking back orders

Redeem on Layaways

All types

No

Single

Boolean

Enabled

Specifies if the points can be redeemed on picking layaways

Redeem on Work Orders

All types

No

Single

Boolean

Enabled

Specifies if the points can be redeemed on picking work orders

Redeem on Refunds

All types

No

Single

Boolean

Enabled

Specifies if the points can be redeemed on transactions that contain returns or exchanges

Maximum discount

All types

No

Single

Percent

0%

A maximum reward discount that could be applied to the transaction. Calculated as percentage of the subtotal. %0 means no limit

Redeem in the same transaction

All types

No

Single

Boolean

Enabled

The option allows the ability to redeem the loyalty value in the same transaction in which it is collected

Coupon Time Limits

\$C, %C, OC

No

Single

Pair of two integers

1/30

Determines the coupon availability time frame: days before activation / days valid after activation

Any optional Boolean rule (e.g., “Redeem for Work Orders”) is always enabled when added. If the rule is not to be enabled, simply do not add it to the collection schedule.

Last updated