{"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22~1model~1item_qualifiers":{"page":{"type":"openapi-model","title":"Item Qualifiers (Array Object)","uid":"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22~1model~1item_qualifiers","breadcrumbs":[{"type":"root-group","path":"/","uid":"XriN6EjULnKiQ_SEym0Jb84VLfsHqB-Mtwc5Bp_N","title":"Platform Functions"},{"type":"group","path":"/apis/platform-functions-api","title":"Platform Functions API - Endpoint Reference Topics"},{"type":"page","path":"/apis/offers-ingestion-api","title":"Offers Ingestion API"}],"version":"default","documentUid":"DnobVB-XwfX0nmZkftqj9ZSWO5_eqJnjbiHBXM22","modelName":"item_qualifiers","ref":"#/components/schemas/item_qualifiers","navigationId":"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22/model/item_qualifiers"},"content":{"components":{"schemas":{"item_qualifiers":{"title":"Item Qualifiers (Array Object)","x-stoplight":{"id":"lq6pjd2djqiak"},"type":"array","description":"List of items qualifiers associated with the qualification criteria (QC). The object lists the items that must be present on the check to meet the QC. The processing function is triggered only if the receipt satisfies all of the conditions specified in the object’s attributes.","items":{"x-stoplight":{"id":"kgfyi17oejibs"},"type":"object","properties":{"expression_type":{"type":"string","x-stoplight":{"id":"gltluqx6d4l5g"},"description":"List of predefined functions that define various conditions under which a receipt is eligible for further processing. These conditions evaluate whether the receipt meets certain requirements before triggering the processing function. The system will skip the item if the expression type is not a valid value. Possible values include:\n* line_item_does_not_exist - The specified line item must NOT be present on the receipt.\n* line_item_exists (default) - The specified line item must be present on the receipt.\n* net_amount_excluding_min_priced_item_equal_to_or_more_than - The total net amount on the receipt, excluding the lowest-priced item, must be equal to or greater than the specified amount.\n* net_amount_excluding_max_priced_item_equal_to_or_more_than - The total net amount on the receipt, excluding the highest-priced item, must be equal to or greater than the specified amount.\n* net_quantity_greater_than_or_equal_to - The total quantity of the specified item(s) must be equal to or greater than the specified value.\n* net_amount_greater_than_or_equal_to - The total net amount on the receipt must be equal to or greater than the specified amount.\n* net_quantity_equal_to - The total quantity of the specified item(s) must be exactly equal to the specified value."},"line_item_selector":{"$ref":"#/components/schemas/qc_line_item_selector"},"net_value":{"type":"number","x-stoplight":{"id":"ujngr39da676u"},"description":"Specifies the required numeric threshold (such as quantity or amount) that the receipt must meet for certain expression_type conditions. `net_value` is an additional parameter that depends on the selected `expression_type`. It must be an integer and greater than zero. However, if `expression_type` is set to either \"line_item_exists\" or \"line_item_does_not_exist\", `net_value` will be ignored and treated as null, even if a value is provided."}}}},"qc_line_item_selector":{"title":"Line Item Selector (Object)","x-stoplight":{"id":"ztq2iadcevh3g"},"type":"object","description":"Shows the details of the line item selector (LIS) associated with the qualification criteria (QC)","properties":{"name":{"type":"string","x-stoplight":{"id":"4s05n4ycy6p3k"},"description":"Name of the line item selector (LIS)"},"external_id":{"type":"string","x-stoplight":{"id":"ddvmls9vihm0a"},"description":"External transaction identifier (UUID) sent by the external system to track if a particular entity is successfully created in the Punchh system"},"exclude_non_payable":{"type":"boolean","x-stoplight":{"id":"79pikqyqcajbf"},"description":"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 \n\nNote: Applicable when `filter_item_set` is set to base_and_modifiers"},"filter_item_set":{"type":"string","x-stoplight":{"id":"2v3tfpeni9ta6"},"description":"The value determines which item(s) will be eligible for the discount. Possible values:\n* 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.\n* modifiers_only: The line item selector (LIS) will be considered a modifier, and a discount will be applied to the modifier amount value only.\n* base_and_modifiers: The discount will be applied to the base and modifier total value."},"base_items":{"$ref":"#/components/schemas/base_items"},"modifiers":{"$ref":"#/components/schemas/modifiers"}}},"base_items":{"title":"Base Items (Object)","x-stoplight":{"id":"i2wkaqftnszca"},"type":"object","description":"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.","properties":{"clauses":{"type":"array","x-stoplight":{"id":"vcgu0lqswges4"},"description":"List of clauses for filtering base items. The base item discount will be applied only if `filter_item_set` is set to base_only or base_and_modifiers.","items":{"x-stoplight":{"id":"drl3vx8knxlpp"},"type":"object","properties":{"attribute":{"type":"string","x-stoplight":{"id":"dls4vyq6g9bjs"},"description":"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 base items, you will complete at least one of the following attributes. The possible values for the attribute(s) are:\n\n* item_name: Filter the item using the item name in your POS system (e.g., \"Sandwich\").\n* 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.\n* quantity: Filter based on the number of units purchased (e.g., \"at least 2 sandwiches\").\n* 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.\n* 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.\n* item_serial_number: Filter the item using the item’s serial number in your POS system.\n* 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\n* item_total_amount: Filter based on the exact price or range of prices (e.g., items above a certain amount).\n"},"operator":{"type":"string","x-stoplight":{"id":"1t6bv3000jz33"},"description":"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","x-stoplight":{"id":"tcg7394y8q5nn"},"description":"Value of the attribute that needs to be filtered"}}}}}},"modifiers":{"title":"Modifiers (Object)","x-stoplight":{"id":"w4lf29swhlpt2"},"type":"object","description":"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.","properties":{"clauses":{"type":"array","x-stoplight":{"id":"ddt1jq7sko9sh"},"description":"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.","items":{"x-stoplight":{"id":"tuue0psh30q24"},"type":"object","properties":{"attribute":{"type":"string","x-stoplight":{"id":"m2yei58cpf9dm"},"description":"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:\n* item_name: Filter the item using the item name in your POS system (e.g., \"Sandwich\").\n* 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.\n* quantity: Filter based on the number of units purchased (e.g., \"at least 2 sandwiches\").\n* 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.\n* 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.\n* item_serial_number: Filter the item using the item’s serial number in your POS system.\n* 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\n* item_total_amount: Filter based on the exact price or range of prices (e.g., items above a certain amount).\nThis 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","x-stoplight":{"id":"ahxvy2m1x3qnk"},"description":"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","x-stoplight":{"id":"7i9bciifthc2t"},"description":"Value of the attribute that needs to be filtered"}}}},"processing_method":{"type":"string","x-stoplight":{"id":"nj0gbkyn97wxi"},"description":"States how the modifiers will be selected for further processing when `max_discount_units` are defined. Possible values: \n* max_price - Specifies that the most expensive modifiers are discounted first\n* min_price - Specifies that the least expensive modifiers are discounted first"},"max_discount_units":{"type":"integer","x-stoplight":{"id":"j9m1uwbxi2wi3"},"description":"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."}}}}}}}}