Line Item Selector (Object)

Shows the details of the line item selector (LIS) associated with the qualification criteria (QC)

  • base_items
    Type: Base Items (Object)

    When building a new line item selector (LIS), you will define a base item, a modifier, or both. A base item is the 'main' item. For example, a hamburger.

  • exclude_non_payable
    Type: boolean

    When one or more discounts are returned as a modifier to the base item, and if the net amount for the modifier after the discount(s) is zero, the items will be excluded from the LIS. As a result, the item will not be considered when evaluating a receipt using the qualification criteria (QC) to which the LIS is linked. However, the base of the same LIS can be evaluated for additional discounting. Possible values: true, false

    Note: Applicable when filter_item_set is set to base_and_modifiers

  • external_id
    Type: string

    External transaction identifier (UUID) sent by the external system to track if a particular entity is successfully created in the Punchh system

  • filter_item_set
    Type: string

    The value determines which item(s) will be eligible for the discount. Possible values:

    • base_only: The line item selector (LIS) will be considered a base item, and the discount will be applied to the base item value only.
    • modifiers_only: The line item selector (LIS) will be considered a modifier, and a discount will be applied to the modifier amount value only.
    • base_and_modifiers: The discount will be applied to the base and modifier total value.
  • modifiers
    Type: Modifiers (Object)

    A modifier is an item that may accompany a base item. For example, if the base item is a hamburger, a modifier could be pepper jack cheese.

  • name
    Type: string

    Name of the line item selector (LIS)