Skip to main content

Xenial Product Documentation

Item-Level Discount

Xenial Cloud Portal 4-Dot Menu Data Management Ordering Settings Discounts & Fees Discount List

To create an item-level discount:

  1. From the upper-right of the Discount Definition List screen, select New Discount Definition.

  2. From the menu pane on the left, select a page and define the respective settings.

    The following introduces the pages of the Discount List editor.

    Page

    Description

    General

    Define general settings about a discount including an alternate code or code range.

    Availability

    Define availability settings by site, order source, time period, and order destination.

    Schedule

    Schedule when the discount is available for use at the POS.

    Rules (Item-Level)

    Define rules that govern the application of the discount at the POS.

    Qualify Criteria

    Define the criteria an order must meet at the POS to qualify for the discount.

    Apply Criteria (Item-Level)

    Identify the items that are eligible for the discount.

    Roles

    Identify the Xenial roles that have permission to apply the discount at the POS.

General

From the General page of the Discount List editor, define general settings about a discount, including the discount name, type, and discount method.

  1. From the General page, locate the General section.

  2. From the General section, define the following:

    Field

    Description

    Discount Name

    Type a name for the discount.

    External ID

    Type the external identifier to assign to the discount record.

    External identifiers are references used by third-party partners / integrators.

    Discount Code

    Type a code to identify the discount.

    Discount Type

    From the dropdown, select the term that best describes the discount type.

    Discount Method

    From the dropdown, select the method to discount eligible order items:

    % Off

    Fixed Percent

    In the Value field, type the discount percent.

    $ Off

    Fixed Amount

    In the Value field, type the currency amount of the discount.

    % Off (prompt)

    Variable Percent

    The cashier is prompted to type the discount percent.

    In the Max Value field, type the maximum discount percent.

    $ Off (prompt)

    Variable Amount

    The cashier is prompted to type the currency amount.

    In the Max Value field, type the maximum currency amount.

    Forced Price

    The regular price is replaced with a new price.

    In the Value field, type the new price.

    Distribute Across Scope

    Toggle On to distribute the discount amount evenly across the eligible order items.

    Toggle Off to apply the total discount amount to each eligible order item on the order.

    This toggle is only available for the following Discount Methods:

    • $ Off

    • $ Off (Prompt)

    • Forced Price

    Value

    Type the discount value. This value corresponds to the selected Discount Method.

    For example, to configure a $1 Off discount, type 1 in the provided field.

    This field is only available for the following Discount Methods:

    • % Off

    • $ Off

    • Forced Price

    Max Value

    Type the maximum discount value. This value corresponds to the selected Discount Method.

    For example, to define a maximum discount value of $1 Off, type 1 in the provided field.

    This field is only available for the following Discount Methods:

    • % Off (Prompt)

    • $ Off (Prompt)

    Availability

    Select the Ordering screens where the discount is available:

    • Amount Tender Screen - The Discount menu accessible from the Tender screen.

    • Barcode Scan - Allow the cashier to apply the discount using a barcode scanner.

    • Order Entry - The Discount menu accessible from the Order Entry screen.

    Use Loyalty

    Toggle On if the discount is processed through a loyalty engine.

    Enable this toggle when using an integrated loyalty engine, such as the Mobile API.

Printing

To define printing settings for the discount:

  1. From the General page, locate the Printing section.

  2. Toggle Print Discount Receipt to On to always print a separate copy of the discount receipt at the POS.

Employee Discount

To define settings for an employee discount:

  1. From the General page, locate the Employee Discount section.

  2. Toggle Employee Discount to On to identify the discount as an employee discount:

    Toggle

    Description

    Lookup by Name

    Toggle On to enable the cashier to lookup the employee receiving the discount by their name.

    Clocked in Employees Only

    Toggle On to only allow this discount for employees who are clocked in.

Alternate Discount Codes

To enable the order taker to add the discount using alternate codes:

  • Single Code - Assign a single alternate code to the discount.

  • Code Range - Define a range of alternate codes to assign to the discount.

Single Code
  1. From the General page, locate the Alternate Discount Codes section.

  2. Select Add Alternate Discount Code.

  3. From the Type dropdown, select the applicable Code.

  4. In the Code field, scan or type the PLU barcode information.

  5. From the lower-right of the Alternate Discount Code window, select Done.

Code Range
  1. From the General page, locate the Alternate Discount Codes section.

  2. Select Add Alternate Discount Code.

  3. From the Type dropdown, select the applicable Code Range.

  4. In the Range Start field, type the first PLU barcode in the range.

  5. In the Range End field, type the last PLU barcode in the range.

  6. From the lower-right of the Alternate Discount Code window, select Done.

Availability

From the Availability page of the Discount List editor, define availability settings for a discount.

  1. From the Availability page, locate the Availability section.

  2. Toggle Active to Active if the discount is available for use at the site.

    • Multi-site users: To the right of the field, select the globe icon to define values for each site.

  3. From the Availability Conditions section, define availability settings for order sources, time periods, and order destinations.

Order Sources

Identify the order sources that are eligible for the discount:

  1. From the Availability Conditions section, locate the Order Sources line.

  2. To the far-right of the Order Sources line, select Edit from the 3-dot menu.

  3. From the Condition dropdown, select the applicable option:

    Option

    Description

    All

    (Default) The discount is available for all order sources.

    Only the Following

    The discount is only available for the selected order sources.

    1. Select Add Order Sources.

    2. From the Add Order Sources window, select the order sources.

    3. From the lower-right, select Add # Order Sources.

    4. From the lower-right, select Add Condition.

    Excluding the Following

    The discount is available for all order sources EXCEPT for the selected order sources.

    1. Select Add Order Sources.

    2. From the Add Order Sources window, select the order sources.

    3. From the lower-right, select Add # Order Sources.

    4. From the lower-right, select Add Condition.

Time Periods

Identify the time periods that are eligible for the discount:

  1. From the Availability Conditions section, locate the Time Periods line.

  2. To the far-right of the Time Periods line, select the 3-dot menu, and then select Edit from the dropdown.

  3. From the Condition dropdown, select the applicable option:

    Option

    Description

    All

    (Default) The discount is available for all time periods.

    Only the Following

    The discount is only available for the selected time periods.

    1. Select Add Time Periods.

    2. From the Add Time Periods window, select the time periods.

    3. From the lower-right, select Add # Time Periods.

    4. From the lower-right, select Add Condition.

    Excluding the Following

    The discount is available for all time periods EXCEPT for the selected time periods.

    1. Select Add Time Periods.

    2. From the Add Time Periods window, select the time periods.

    3. From the lower-right, select Add # Time Periods.

    4. From the lower-right, select Add Condition.

Destinations

Identify the order destinations that are eligible for the discount:

  1. From the Availability Conditions section, locate the Destinations line.

  2. To the far-right of the Destinations line, select Edit from the 3-dot menu.

  3. From the Condition dropdown, select the applicable option:

    Option

    Description

    All

    (Default) The discount is available for all order destinations.

    Only the Following

    The discount is only available for the selected order destinations.

    1. Select Add Destinations.

    2. From the Add Destinations window, select the order destinations.

    3. From the lower-right, select Add # Order Destinations.

    4. From the lower-right, select Add Condition.

    Excluding the Following

    The discount is available for all order destinations EXCEPT for the selected order destinations.

    1. Select Add Destinations.

    2. From the Add Destinations window, select the order destinations.

    3. From the lower-right, select Add # Order Destinations.

    4. From the lower-right, select Add Condition.

Schedule

From the Schedule page of the Discount List editor, schedule the availability of the discount.

Field

Description

Start Date

Type the first date when the discount is available.

End Date

Type the last date when the discount is available.

Start Time

Type the time of day when the discount promotion begins.

End Time

Type the time of day when the discount promotion ends.

Note

  • Type the date in MM/DD/YYYY format -OR- Select the date from the dropdown calendar.

  • Type the time in HH/MM/SS AM/PM format -OR- Select the time from the popup clock.

Rules (Item-Level)

From the Rules page of the Discount List editor, define rules that govern the application of the discount:

From the Rules section, define the following:

Rule

Description

Priority

Type the priority to assign to the discount in relation to other active discounts.

If multiple discounts are available, the priority value determines which discount to apply first. A discount with a priority of 1 is applied before a discount with a priority of 2.

Max Discount Amount

Type the maximum currency amount that can be discounted from the item price.

Minimum Order Subtotal

Type the minimum subtotal required for an order to qualify for the discount.

Discount Application Setting

From the Rules section, define the following:

Lowest Priced Item

(Default) Apply the discount to the order item with the lowest price.

  • If the discount is applied to more than one item, select this option to apply the discount to the item with the lowest price first.

  • This option minimizes the discount value.

Highest Priced Item

Apply the discount to the order item with the highest price.

  • If the discount is applied to more than one item, select this option to apply the discount to the item with the highest price first.

  • This option maximizes the discount value.

Next Highest Priced Item

Apply the discount to the second-highest priced order item when more than one item qualifies.

  • Select this option if the purchase of a higher-priced item is required to qualify for a discount on a lower-priced item.

  • This option is only available for item-level discounts.

Amount Application Rule

Select the desired option:

Gross Item Amount

(Default) Discount the gross amount of the item price.

Net Item Amount

Discount the net amount of the item price.

When Discount Added, Apply

From the dropdown, select the rule for discounts that are automatically applied:

Once

Apply the discount to one eligible item.

To everything applicable

Apply the discount to all eligible items on the order.

Up to <n> Number of Times

Specify the maximum number of times to apply the discount when the order includes multiple eligible items.

  • Type the maximum number times in the # of times field.

  • For example, if the # of times field value is 2, the discount is only applied to two items no matter how many eligible items are on the order.

    If the order includes only one eligible item, the discount is applied once.

Discount can be applied manually

From the dropdown, select the rule for discounts that are manually applied:

Once

Apply the discount to one eligible item.

Unlimited number of times

Apply the discount to all eligible items no matter how many are included on the order.

Specified number of times

Specify the maximum number of times the cashier may apply the discount when the order includes multiple eligible items.

  • Type the maximum number of times in the Number of times field.

Discount Application Method

From the dropdown, select the method for applying the discount:

Manual

The cashier applies the discount.

Automatic

The discount is automatically applied to eligible order items.

Automatic discounts are applied when the cashier selects:

  • The Total Order button to proceed to the tender screen.

  • The Send button to send the order to the kitchen.

  • The Save button to save the order.

Apply Unfulfilled Discounts

From the dropdown, select the desired behavior for the discount:

Use Site Preference

The setting value defined in the Site Preferences editor is used for this discount.

This setting is defined from the Ordering Application → Ordering section of the Site Preferences editor.

Allow

The user is allowed to add the discount to the order first, and then add the necessary order item(s) to satisfy the requirements of the discount.

Forbid

The user must add the required order item(s) before the discount can be added to the order.

When Discount Placeholder is Selected

From the dropdown, select the desired behavior when the user selects the placeholder for an unfulfilled discount:

  • Use Site Preference

  • Display Filtered Product List

  • Generate Menu View (default behavior)

Exclusive Options

Select the desired option(s):

Exclusive Before

Do not apply the discount if another discount is already applied.

Exclusive After

Do not allow other discounts (including customer loyalty) once the discount is applied.

Apply Post Tax

Toggle On to apply the discount AFTER all applicable taxes are applied and calculate.

Customer Information

Follow these steps if a discount is only eligible for specific customers (e.g. military personnel, students, police officers).

To define customer information for a discount:

  1. From the Rules page, locate the Customer Info section.

  2. From the Customer Info section, select Add Item.

  3. In the Name field, type the name or description of the customer type.

  4. In the Prompt field, type a message to display to the cashier when this discount is applied.

    • For example, add a message to remind the cashier that the customer must show their ID to receive the discount.

Qualify Criteria

From the Qualify Criteria page of the Discount List editor, define the criteria the guest's order must meet to qualify for the discount.

  1. From the Qualify Criteria page, locate the Inclusive Criteria section.

  2. From the Application Method field, select the desired method for applying the discount criteria. The criteria can include items that must be present in the order, but are not discounted.

    Method

    Description

    Purchase All in List

    The order must include all the identified items to qualify for the discount.

    Purchase Any in List

    The order must include at least one of the identified items to qualify for the discount.

  3. In the Label field, type the placeholder name to display at the POS for unfulfilled discounts.

  4. From the Required Items section, select Add Item Set.

  5. From the Add Item Set window, create a set of eligible items for the discount:

    Field

    Description

    Quantity to Discount

    Type the number of items in the set to discount.

    Items with Tags

    (Optional) Select the applicable product tags. All items associated with the identified tags are eligible for the discount

    Label

    Type the placeholder name to display at the POS for unfulfilled discounts for this item set.

    Selected Items

    Select the items that are eligible for the discount:

    1. Select Add Items.

    2. From the Add Items window, select the eligible items.

    3. From the lower-right, select Add # Items.

  6. From the Add Item Set window, select Save Set.

  7. Repeat steps 3-5 to add additional item sets (if necessary).

(Optional) To identify items that disqualify an order for a discount:

  1. From the Qualify Criteria page, locate the Exclusive Criteria section.

  2. From the Tags dropdown, select the product tags that disqualify the order.

    If a guest's order contains any item that is associated with the selected tags, the order is NOT eligible for the discount.

Apply Criteria (Item-Level)

From the Apply Criteria page of the Discount List editor, define application criteria for a discount.

  1. From the Apply Criteria page, locate the Apply Criteria section.

  2. From the Apply Criteria section, define the following settings:

    Setting

    Description

    Apply Type

    Select Item(s) to indicate the discount is applied to one or more eligible items on an order.

    Label

    Specifies the placeholder name to display at the POS for unfulfilled discounts.

    Qualify/Apply Child Items Independently

    Toggle Yes to apply the discount to child items independently from their parent item.

    Apply to Liability Items

    Toggle Yes if gift cards and gift certificates are eligible for the discount.

    Apply to

    Select the applicable options:

    • Child Items - The discount is applied to child items.

      If this option is NOT selected, child item prices are excluded from the discount calculation when the discount is applied to the parent item.

    • Modifiers - The discount is applied to item modifiers. Negatively-priced item modifiers are not discounted.

      If this option is NOT selected, modifier prices are excluded from the discount calculation when the discount is applied to the parent item.

Identify Eligible Items

The following describes how to identify the items to which the discount is applied. Identify a single set or multiple sets of items.

Single Set of Items
  1. From the Apply Criteria page, locate the Items section.

  2. From the Items section, define the following:

    Field

    Description

    Multiple Sets of Items

    Toggle to No.

    Use a Product for Discount Basis

    This setting is only available for the following discount methods: "% Off" and "Forced Price".

    Toggle ON to select an alternative item for the discount. The price of the selected alternative item is used when calculating the discount.

    Toggle OFF to disable this feature.

    Discount Basis Product

    This field is only available when Use a Product for Discount Basis is toggled ON.

    From the dropdown, select the alternative item for the discount.

    The price of the selected item is used when calculating the discount, regardless of the order item to which the discount is applied.

    Quantity to Discount

    Type the number of items in the set to discount.

    Condition

    From the dropdown, select the applicable option:

    • Only the Following - The items identified in the Applied Items section are eligible for the discount.

    • Exclude the Following - The items identified in the Applied Items section are NOT eligible for the discount.

    Tags

    (Optional) From the dropdown, select the applicable product tags.

    The eligibility of the selected product tags is determined by the option selected from the Condition dropdown above.

  3. From the Applied Items section, identify the items to which the discount is applied. The eligibility of the selected items is determined by the option selected from the Condition dropdown above.

    • Select Add Items.

    • From the Add Items popup window, select the items.

    • From the lower-right of the window, select Add # Items.

  4. From the Roll Up Pricing Behavior section, define how roll up pricing is calculated for the discount.

    From the Include Rolled Up Prices dropdown, select the applicable option:

    Note

    The Roll Up Pricing Behavior section is only available when Multiple Sets of Items is toggled to No.

    Option

    Description

    All Ordered

    (Default) Apply the discount to the sum of the parent price and the rolled up prices of its child items and modifiers (if any).

    If Use a Product for Discount Basis is toggled ON, the discount is applied to the sum of the price of the Discount Basis Product, and the rolled up prices of the child items and modifiers selected for the discounted item.

    Do Not Include

    Apply the discount to the price of the parent item only and exclude the rolled up prices of its child items and modifiers (if any).

    If Use a Product for Discount Basis is toggled ON, the discount is applied to the price of the Discount Basis Product.

    Specified Items

    Apply the discount to the sum of the parent item price and the price of the identified items and modifiers.

    From the Specified Items section, identify the items and modifiers to include:

    1. Select Add Items.

    2. From the Add Items popup window, select the items.

    3. From the lower-right of the window, select Add # Items.

    4. In the Quantity field of the Specified Items section, specify the quantity of each listed item to include in the discount.

    If Use a Product for Discount Basis is toggled ON, the discount is applied to the sum of the price of the Discount Basis Product, and the price of the items and modifiers identified in the discount configuration.

Multiple Sets of Items
  1. From the Apply Criteria page, locate the Items section.

  2. From the Items section, define the following:

    Field

    Description

    Multiple Sets of Items

    Toggle to Yes.

    Apply Condition

    From the dropdown, select the applicable option:

    • All Sets - The order must satisfy all item sets to qualify for the discount.

    • Any from List - The order must satisfy at least one (1) item set to qualify for the discount.

From the Applied Item Sets section, add a set of items to which the discount is applied:

  1. Select Add Item Set.

  2. From the General page of the Add Item Set window, define the following:

    Field

    Description

    Quantity to Discount

    Type the number of items in the set to discount.

    Condition

    From the dropdown, select the applicable option:

    • Only the Following - The items identified in the Selected Items section are eligible for the discount.

    • Exclude the Following - The items identified in the Selected Items section are NOT eligible for the discount.

    Tags

    (Optional) From the dropdown, select the applicable product tags.

    The eligibility of the selected product tags is determined by the option selected from the Condition dropdown above.

    Label

    Type the placeholder name to display at the POS for unfulfilled discounts for this item set.

  3. From the Selected Items section, identify the items that are discounted. The eligibility of the selected items is determined by the option selected from the Condition dropdown above.

    • Select Add Items.

    • From the Add Items popup window, select the items.

    • From the lower-right of the window, select Add # Items.

  4. From the Discount Basis page of the Add Item Set window, define the following:

    Setting

    Description

    Use a Product for Discount Basis

    This setting is only available for the following discount methods: "% Off" and "Forced Price".

    Toggle ON to select an alternative item for the discount. The price of the selected alternative item is used when calculating the discount.

    Toggle OFF to disable this feature.

    Discount Basis Product

    This field is only available when Use a Product for Discount Basis is toggled ON.

    From the dropdown, select the alternative item for the discount.

    The price of the selected item is used when calculating the discount, regardless of the order item to which the discount is applied.

  5. From the Roll Up Pricing Behavior page of the Add Item Set window, define how roll up pricing is calculated for the discount.

    From the Include Rolled Up Prices dropdown, select the applicable option:

    Option

    Description

    All Ordered

    (Default) Apply the discount to the sum of the parent price and the rolled up prices of its child items and modifiers (if any).

    If Use a Product for Discount Basis is toggled ON, the discount is applied to the sum of the price of the Discount Basis Product, and the rolled up prices of the child items and modifiers selected for the discounted item.

    Do Not Include

    Apply the discount to the price of the parent item only and exclude the rolled up prices of its child items and modifiers (if any).

    If Use a Product for Discount Basis is toggled ON, the discount is applied to the price of the Discount Basis Product.

    Specified Items

    Apply the discount to the sum of the parent item price and the price of the identified items and modifiers.

    From the Specified Items section, identify the items and modifiers to include:

    1. Select Add Items.

    2. From the Add Items popup window, select the items.

    3. From the lower-right of the window, select Add # Items.

    4. In the Quantity field of the Specified Items section, specify the quantity of each listed item to include in the discount.

    If Use a Product for Discount Basis is toggled ON, the discount is applied to the sum of the price of the Discount Basis Product, and the price of the items and modifiers identified in the discount configuration.

  6. From the lower-right of the Add Item Set window, select Save Set.

  7. Repeat these steps to add additional item sets (as needed).

Roles

From the Roles page of the Discount List editor, define role restrictions for the discount.

Important

If role restrictions are not defined, all Xenial roles have permission to apply the discount.

  1. From the Roles page, locate the Roles section.

  2. Toggle Restrict By Roles to On.

  3. Identify the roles that have permission to apply the discount:

    • From the Available column, select a role.

    • Select the right arrow to move the role to the Included column.

    • Select the left arrow to remove a selected role from the Included column.