For the complete documentation index, see llms.txt. This page is also available as Markdown.
loyaltyLoyalty Managercollection schedulecollection rulesrequired fieldprice pointsbasket pointsquantity points

Collection rules

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

In addition to the collection type, there are also collection rules. Certain rules apply only to certain collection 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 collection schedule (for example, include several customer groups), while others may appear only once (e.g. minimum purchase” for price points).

Rule
Applicable type
Mandatory
Occurrence
Possible value
Default
Description

Include item incentive group(s)

All types

No

Multiple, no duplicates

One or more incentive group(s) The item incentive group(s) that this collection schedule applies

Include customer group(s)

All types

No

Multiple, no duplicates

One or more customer group(s) The customer groups that this collection schedule applies

Exclude item incentive group(s)

All types

No

Multiple, no duplicates

One or more incentive group(s) The item incentive group(s) that this collection schedule does not apply

Exclude customer group(s)

All types

No

Multiple, no duplicates

One or more customer group(s) The customer groups that this collection schedule does not apply

Points per unit

PP, QP

Yes

Single

Positive decimal

1

The number of points collected per unit (dollar for PP or quantity for QP). Ex: - 1 Point for $1 (PP) - 100 points for 1 purchased “1L Milk” (QP)

Points per Basket Value

BP

Yes

Multiple

Pair

$10, 1

Ex: - 1 points for $10 basket - 2 points for $20 basket, etc.

Rounding

PP, BP

No

Single

Pick list: No rounding, Nearest, Down, Up

Nearest

Determines how fractional points are rounded, e.g. 1.55 collected points will round up to 2.0 points with the “Nearest” or “Up” rounding

Minimum purchase

PP

No

Single

Positive currency value

0

Determines that a necessary minimum subtotal is required to collect points

New Customer Bonus Points

PP, BP

No

Single

Positive decimal

0

Adds bonus points to any customer which never had points collected, on the first purchase

Include accelerator(s)

PP, BP

No

Multiple

One or more points accelerator(s) See Points Accelerators further below

Exclude for Discounted

PP, BP

No

Single

Boolean

Enabled

Excludes point collection for any item that is discounted

Exclude for Non-inventory

PP, BP

No

Single

Boolean

Enabled

Excludes point collection for non-inventory items

Exclude for Charges

PP, BP

No

Single

Boolean

Enabled

Excludes points collection for charge items

Exclude for not priced

PP, BP

No

Single

Boolean

Enabled

Excludes points collection for items that are not priced and the cashier manually provides the price

Exclude for vouchers

PP, BP

No

Single

Boolean

Enabled

Excludes points collection voucher item type

Exclude for Redemption

PP, BP

No

Single

Boolean

Enabled

Excludes point collection for a transaction which also contains points redemption

Exclude for layaways

PP, BP

No

Single

Boolean

Enabled

Excludes point collection for layaway transaction types

Exclude for backorders

PP, BP

No

Single

Boolean

Enabled

Excludes point collection for backorder transaction types

Exclude for work orders

PP, BP

No

Single

Boolean

Enabled

Excludes point collection for work orders transaction types

Exclude customers with Discounts

All types

No

Single

Boolean

Enabled

Excludes customers with pre-set discounts

Exclude customers with Price levels

All types

No

Single

Boolean

Enabled

Excludes customers with pre-set price levels

Exclude employees

All types

No

Single

Boolean

Enabled

Excludes customers that are marked as “employees”

Save collected points as item comment

PP

No

Single

Boolean

Enabled

Enables saving the collected points per each item in the line item comment field

Show collected points detail

All types

No

Single

Boolean

Enabled

Enables a popup at the end of the transaction to display the collected points detail

Any optional Boolean rule (e.g., exclude employees) is always enabled when added. If the rule is not to be enabled, simply do not add it to the collection schedule.

Last updated