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.

clauses
Type: array object[]

List of clauses for filtering modifier items. The modifiers discount will be applied only if filter_item_set is set to modifiers_only or base_and_modifiers.
- attribute
  Type: string
  
  The attribute(s) to filter items that should be included in the offer or promotion. The filtering can be done based on specific characteristics of the items. For modifier items, you will complete at least one of the following attributes. Possible values for the attribute(s) are:
  
  item_name: Filter the item using the item name in your POS system (e.g., "Sandwich").
  
  item_id: Filter item(s) using their unique identifier or product code in your POS system. This is the third and most specific level in the POS hierarchy.
  
  quantity: Filter based on the number of units purchased (e.g., "at least 2 sandwiches").
  
  item_family: Filter the item using the unique ID of the item’s family in your POS system (e.g., "1001" or "2002"). This is the middle (second) level in the POS hierarchy.
  
  item_major_group: Filter the item using the unique ID of the major grouping of items in your POS system (e.g., "1000" or "2000"). The major group ID is the top level in the POS hierarchy, above the family group and item ID.
  
  item_serial_number: Filter the item using the item’s serial number in your POS system.
  
  line_item_type: Filter based on the type of the menu item (e.g., "M", "D"). Possible values: Menu Item (M), Discount (D), Service Charge (S), Extra (X), Tax (T), or Payment (P) such as a gift card
  
  item_total_amount: Filter based on the exact price or range of prices (e.g., items above a certain amount). This allows businesses to apply targeted rules to specific items or item groups within a transaction for promotions, discounts, or rewards. For example, if you want to create an LIS that only applies to items with a specific item ID or name, you would use one of these values to define the filtering criteria.
- operator
  Type: string
  
  The value specifies how an attribute should be filtered or selected in the Punchh system. Possible values: ==, !=, >, <, >=, <=, in, is_case_insensitive, in_case_insensitive, not_in, not_in_case_insensitive, like, not_like, in_range, not_in_range, mod, and in_special
- value
  Type: string
  
  Value of the attribute that needs to be filtered
max_discount_units
Type: integer

This value limits the number of units that can be discounted. A unit may be an individual menu item or a menu item bundle, depending on the configured processing function.
processing_method
Type: string
States how the modifiers will be selected for further processing when max_discount_units are defined. Possible values:
- max_price - Specifies that the most expensive modifiers are discounted first
- min_price - Specifies that the least expensive modifiers are discounted first