Order Rules

Overview

Order rules define earn and communications rules for Orders. Specifically, order rules determine the number of points that are to be accrued or earned from orders submitted through a POS API, which is based on the configured order rules. From this determination, an SLvalue is created. The SL value, or total of historical sales for a customer, is applied to calculate the monetary accrual or points earned.

An Order Rule is composed of the following:

  • Base points: Points that are earned from purchases. The Base earn rule specifies the multiplier to be applied, e.g., 1x, .5x, etc., and the order attribute that the multiplier should be applied to, such as Order Subtotal or Qualifying Quantities. 

  • Bonus points: Bonus points are applied in order until either all rules are evaluated, or an applicable rule halts further evaluation. Bonus earn rules are evaluated to determine the total number of points that will be added to the Base Earn total. 

Eligibility Criteria to Determine Bonus Points

Order Rules use the following eligibility criteria for bonus rules:

Note: All eligibility rules must be satisfied to be eligible for a bonus rule.

Eligible Locations

When specified, orders from an eligible location will earn bonus points, and orders from outside of the list of eligible locations will not earn bonus points. All locations are eligible by default. Only existing places can be selected in Eligible Locations. The integration ids will be checked against the store_id  key in the POS payload.

Minimum Qualified Item Quantity

When the sum of qualifying line item quantities is met, the bonus rule will be applied. When it is not met, the bonus rule will not apply. Fully discounted items are not included in the sum of qualifying line item quantities.

Note: The Qualifying Items field is used to filter the items, and the exclusion list is ignored.

Minimum Qualified Item Amount

When the sum of qualifying line item dues is met, the bonus rule will be applied. When it is not met, the bonus rule will not apply.

Note: The Qualifying Items field is used to filter the items, and the exclusion list is ignored.

Minimum Order Subtotal Amount

When the minimum order subtotal is met, the bonus rule will be applied. When it is not met, the bonus rule will not apply.

Access

To access the Rules area of the platform, select Rules from the Main Navigation Menu.

Features

The Order Rules area of the platform includes the following features. You can navigate to each feature selecting the Order Rules section of the Sub-Category Menu, then selecting Bonus Earn Rules.

Set an Eligible Location for Bonus Point Accrual

  1. In the Condition section, the All Locations option is enabled by default. You must uncheck that box in order to select individual existing locations if desired.

  2. From the drop-down, select all locations to be designated as eligible.

  3. Click Save.

Set a Minimum Qualified Item Quantity for Bonus Point Accrual

1.   In the Condition section, under the Minimum Qualified Item Quantity field, enter the sum of qualifying line item quantities required to be eligible for bonus.

2.   Click Save.

Set a Minimum Qualified Item Amount for Bonus Point Accrual

  1. In the Condition section, under the Minimum Qualified Item Amount field, enter the sum of qualifying line item dues required to be eligible for bonus.

  2. Click Save.

 Set a Minimum Order Subtotal Amount for Bonus Point Accrual

  1. In the Condition section, under the Minimum Order Amount field, enter the minimum subtotal amount required to be eligible for bonus.

  2. Click Save.

 Set a Payment Type for Bonus Point Accrual

  1. In the Condition section, click on the Payment Type dropdown. Select the desired type, such as Apple Pay, Cash, Google Pay, etc.

  2. Click Save.

Set a Payment Network for Bonus Point Accrual

  1. In the Condition section, click on the Payment Network dropdown. Select the desired type, such as Amex, Mastercard, Visa, etc.

  2. Click Save.

 Set a Minimum Payment Amount for Bonus Point Accrual

  1. In the Condition section, click on the Minimum Payment Amount dropdown. Enter a value larger than zero.

  2. Click Save.


Cloning a Bonus Rule

You may select an existing bonus earn rule and then create a duplicate copy of it (no manual creation necessary). Users can copy the rule as needed and adjust it quickly.

1. Navigate to Rules > Order Rules, then click into an existing order rule.

2. Click on the Bonus Earn Rules tab.

3. In the upper-right corner of the bonus rule, click on Clone.

4. After clicking on the Clone button, a Clone Rule pop-up is displayed that allows you to update the display name and description. Click Save.

5. The copied rule will include all attributes of the original bonus rule.


Selecting Multiple Locations on Bonus Rules

1. Navigate to Rules > Order Rules, then click into an existing order rule.

2. Click on the Bonus Earn Rules tab.

3. In the Eligible Locations field,

  • Search and select one or more eligible locations listed. Recently selected places are displayed for quick access. Note that as you are typing in a location, the results will update/populate in real time. Additionally, results that are displayed are ordered by Display Name and will display Integration ID, Place Display Name, and Place Internal Name. Finally, click Save at the bottom of the Eligible Locations field.



  • You can also select the All Locations checkbox to the right of the field to ensure all locations will be included. Click Save in the upper-right corner.


Editing a Bonus Rule

Users can edit the name and/or description of an existing bonus earn rule and save it without having to delete and create a new one.

1. Navigate to Rules > Order Rules, then click into an existing order rule.

2. Click on the Bonus Earn Rules tab.

3. In the upper-right corner of the bonus rule, click on the pencil icon.

4. After clicking on the Edit icon, an Edit Bonus Rule pop-up is displayed that allows you to update the display name and description. Click Save.

Note that any other entered values in the bonus rule are not changed.

 

Bonus Calculation

The bonus calculation type uses the sum of quantities across all qualifying line items as the multiplicand. Note that fully discounted items are excluded in the sum of item quantities.

  • Eligible Subtotal: The bonus multiplier is based on the order subtotal. Bonus rules based on subtotals will typically only need an exclusion list.

  • Item Amount: The bonus multiplier is based on the item amount. Such line items will typically only need inclusion lists.

  • Fixed Amount: The bonus multiplier is based on a fixed amount, e.g., a purchase will always earn 100 bonus points. Fixed amounts can be based on line items with a matching SKU or on any order in the time period with some excluded items.

  • Qualified Item Quantity: The bonus multiplier is applied to each line item amount for any line with qualifying items. The bonuses for each qualifying line item are summed to determine the total bonus points awarded.