{"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22~1model~1qc_data_input":{"page":{"type":"openapi-model","title":"QC Input (Object)","uid":"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22~1model~1qc_data_input","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":"qc_data_input","ref":"#/components/schemas/qc_data_input","navigationId":"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22/model/qc_data_input"},"content":{"components":{"schemas":{"qc_data_input":{"title":"QC Input (Object)","x-stoplight":{"id":"i0yltuftvwcf6"},"type":"object","properties":{"data":{"type":"array","x-stoplight":{"id":"l2eplxkth3jif"},"description":"A list of qualification criteria (QC) that need to be created","items":{"x-stoplight":{"id":"289v9n9x325ut"},"type":"object","properties":{"name":{"type":"string","x-stoplight":{"id":"2eejxuoc3a0j2"},"description":"Name of qualification criteria (QC). The name can be up to 255 characters long.","maxLength":255,"minLength":1},"external_id":{"type":"string","x-stoplight":{"id":"kfc6g16pwg8rh"},"description":"A unique identifier (UUID) sent by the external system to track whether a particular entity is successfully created in the Punchh system. It serves as a primary key for the external system. If no `external_id` is provided, the Punchh system will automatically generate a default `external_id`, either as a 40-character hexadecimal string or as a 36-character UUID. For example:\n* Alphanumeric hexadecimal with length 40: 875a6a33ed0f2410d8ac671c2d07c9351ca2f88e"},"amount_cap":{"type":"number","x-stoplight":{"id":"2jljgc0nhidbe"},"description":"Maximum amount that can be earned/redeemed on any receipt. The value should be greater than or equal to 0 and less than or equal to 99999 if provided.","minimum":0,"maximum":99999,"format":"float"},"percentage_of_processed_amount":{"type":"number","x-stoplight":{"id":"jjdphn7hfc01q"},"description":"Percentage of processed amount that can be earned/redeemed on any receipt. The value should be greater than or equal to 0 and less than or equal to 99999 if provided.","minimum":1,"maximum":99999,"format":"float"},"qc_processing_function":{"type":"string","x-stoplight":{"id":"i2extlgbomzij"},"description":"Function applied on filtered menu items of the receipt. Processing functions return a processed value that governs discounting and earning depending on where the qualification criterion is attached. If it is applied in a discounting scenario, the processed value controls the discount amount. If it is applied in an earning scenario (e.g., a rewards program), the processed value controls how much is earned (such as reward points). This parameter is optional when updating qualification criteria (QC).\n\nPossible values: hit_target_price, rate_rollback, bundle_price_target, bundle_price_target_advanced, hit_target_price_max_price_once, hit_target_price_min_price_once, sum_amounts_incremental, static_amount, receipt_subtotal, bogof, bogof2, sum_amounts, receipt_total_amount, sum_qty\n\nFor more information on possible values, see the [Processing Functions]( https://support.punchh.com/s/article/Processing-Functions) article on the Support Portal.\nNote: To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions [here](https://support.punchh.com/s/article/How-do-I-access-the-Punchh-Support-Portal-Single-Sign-On) to access the Punchh Support Portal."},"qualifying_expressions_operator":{"type":"string","x-stoplight":{"id":"7in7ag4licd2z"},"description":"Specifies how offer conditions in `item_qualifiers` are evaluated. Possible values: All, Any. The default value is \"All\". Use \"All\" when every condition must be met, or \"Any\" when satisfying at least one condition is sufficient.","default":"All"},"item_filter_expressions_operator":{"type":"string","x-stoplight":{"id":"h4v56u7aissz7"},"description":"Specifies how offer conditions in `line_item_filters` are evaluated. Possible values: All, Any. The default value is \"All\". Use \"All\" when every condition must be met, or \"Any\" when satisfying at least one condition is sufficient.","default":"All"},"discount_evaluation_strategy":{"type":"string","x-stoplight":{"id":"pzgh5l2yr74vm"},"description":"Specifies whether the maximum or minimum discount should be applied when multiple conditions are met. Note: This parameter should be provided when `item_filter_expressions_operator` is set to Any. Possible values: Min, Max. The default value is \"Min\".","default":"Min"},"rounding_rule":{"type":"string","x-stoplight":{"id":"6nidyy7xcjlpn"},"description":"If the processing function returns a float value, it will be rounded according to the chosen rounding rule. If no rule is selected, the float value will be used as is. A value is required to be sent in the parameter depending on the processing function selected. Possible values: \n* round: This rule rounds the float value to the nearest integer. If the decimal part is 0.5 or higher, the value is rounded up. If the decimal part is less than 0.5, the value is rounded down. For example, 4.3 becomes 4, and 4.7 becomes 5.\n* ceil: This rule rounds the float value up to the next highest integer, regardless of the decimal part. For example, 4.3 becomes 5.\n* floor: This rule rounds the float value down to the next lowest integer, regardless of the decimal part. For example, 4.3 becomes 4."},"max_discount_units":{"type":"integer","x-stoplight":{"id":"49gq1hglnuxez"},"description":"This value limits the number of units that can be discounted. A value is required to be sent in the parameter depending on the processing function (`qc_processing_function`) types selected, such as rate_rollback, bundle_price_target, bundle_price_target_advanced, and sum_amounts_incremental.","minimum":0,"maximum":99999},"minimum_unit_rate":{"type":"number","x-stoplight":{"id":"zfbtdc1ifud9v"},"description":"Minimum unit price threshold. After applying the discount, the minimum unit rate should not be below this amount. A value greater than or equal to 0.01 and less than or equal to 99999 is required if the processing method (`qc_processing_function`) is rate_rollback.","minimum":0.01,"maximum":99999},"unit_discount":{"type":"number","x-stoplight":{"id":"lxoccu80hjqgt"},"description":"Discount to be applied to the rate of the selected items chosen for the offer or promotion. The discount is based on a specific rate (e.g., per unit of item -- per gallon, per liter, etc.). For example, for a fuel discount of 20 cents per gallon, you need to specify the discount in a decimal format (like 0.2) to reflect a 20-cent reduction for each gallon of fuel. If the qualification criteria are attached to a subscription plan, the value of the unit discount will be picked up from the subscription plan; even though you are required to enter a value for the discount (e.g., 0.2 for 20 cents), this value will be ignored if the QC are part of a subscription plan, because the discount will be controlled by the subscription plan's settings instead. The value should be greater than or equal to 0.01 and less than or equal to 99999 if the processing method (`qc_processing_function`) is rate_rollback. A value is required to be sent in the parameter depending on the processing function selected.","format":"float"},"target_price":{"type":["number"],"x-stoplight":{"id":"1xqs99evdc90e"},"description":"Discount selected menu items to achieve this target unit price. For example, if locations sell a burger for variable pricing, a target unit price is achieved by using the appropriate processing function. If a burger is sold at different prices at different locations (e.g., one location sells it for $10, another for $12), you can set a target price (e.g., $9) to standardize the price across locations. The system applies discounts to bring the price down to $9, no matter what the original price was. A value is required to be sent in the parameter depending on the processing function (`qc_processing_function`) types selected, such as hit_target_price, hit_target_price_max_price_once, hit_target_price_min_price_once, bundle_price_target, and bundle_price_target_advanced.","minimum":0.01},"effective_location":{"type":["array"],"x-stoplight":{"id":"xdwh79i6ie9ez"},"description":"An array of valid existing location IDs and/or location group (tag) IDs. The default is an empty array ([]). Restricts redemption to the specified locations or groups. Use the format \"location:\" or \"tag:\". Example: [\"location:123\", \"tag:456\"]. The maximum allowed combined total of locations and location groups is 50.","items":{"x-stoplight":{"id":"rp8hc7d4ducg4"},"type":"string"}},"stack_discounting":{"type":"boolean","x-stoplight":{"id":"xfspaqyhy1rfi"},"description":"When stacking is set to true, this discount can be redeemed with any other discount that contains the same target item. If set to false, only one discount can be applied to the target item, even if multiple discounts are available. \"Y\", \"YES\", \"1\", \"TRUE\", and \"ON\" (case-insensitive) are treated as true. Any other values are considered false."},"reuse_qualifying_items":{"type":"boolean","x-stoplight":{"id":"50m3u684y74bx"},"description":"When set to true, it allows qualifying item(s) to be reused when redeemed with other discounts that apply to the same item(s). When set to false, it restricts qualifying item(s) from being reused for multiple discounts. \"Y\", \"YES\", \"1\", \"TRUE\", and \"ON\" (case-insensitive) are treated as true. Any other values are considered false."},"line_item_filters":{"$ref":"#/components/schemas/qc_line_item_filters_input"},"enable_menu_item_aggregator":{"type":"boolean","x-stoplight":{"id":"h4ycxre7l7973"},"description":"Whether the system will combine (aggregate) multiple instances of the same menu item into one entry based on the attributes defined in `aggregator_grouping_attributes`. \"Y\", \"YES\", \"1\", \"TRUE\", and \"ON\" (case-insensitive) are treated as true. Any other values are considered false."},"aggregator_grouping_attributes":{"type":"object","x-stoplight":{"id":"lni6h7tgnwsss"},"description":"Attributes that have to be matched to aggregate menu items. All menu items with identical attributes are treated as the same, and the total quantity is the sum of its occurrences on the receipt. This parameter is required if `enable_menu_item_aggregator` is sent as true.","properties":{"item_name":{"x-stoplight":{"id":"1jyct3ow75yf2"},"type":"boolean","description":"Indicates whether to group menu items with the same item name together and aggregate their quantities. Possible values: true, false"},"item_id":{"type":"boolean","x-stoplight":{"id":"8d7po504bgshy"},"description":"Indicates whether to group menu items with the same item ID together and aggregate their quantities. Possible values: true, false"},"item_major_group":{"type":"boolean","x-stoplight":{"id":"orcwljrl9wn46"},"description":"Indicates whether to group menu items with the same ID of the major grouping of items and aggregate their quantities. Possible values: true, false"},"item_family":{"type":"boolean","x-stoplight":{"id":"0xwndctk8bkq3"},"description":"Indicates whether to group menu items with the same ID of the item’s family together and aggregate their quantities. Possible values: true, false"},"line_item_type":{"type":"boolean","x-stoplight":{"id":"7ch5hbxcx3eza"},"description":"Indicates whether to group menu items with the same type of menu item together and aggregate their quantities. Possible values: true, false"}}},"item_qualifiers":{"$ref":"#/components/schemas/qc_item_qualifiers_input"},"receipt_qualifiers":{"$ref":"#/components/schemas/receipt_qualifiers"}},"required":["external_id","qc_processing_function"]}}},"required":["data"]},"qc_line_item_filters_input":{"title":"QC Input - Line Item Filters","x-stoplight":{"id":"p2j01i99nn06q"},"type":"array","description":"Lists the items to be discounted by using filters to select applicable menu items. Leave the filter empty to apply the discount to all menu items. If multiple items are selected, the processing function will be applied to each, and the final result will be the sum of all values.\n\nNote: When updating line item filters, do not pass this object if you do not want to update `line_item_filters`. If an empty array object [] is provided, all previously created line item filters will be deleted.\n","items":{"x-stoplight":{"id":"dw7o6he1vftrf"},"type":"object","properties":{"line_item_selector_id":{"type":"string","x-stoplight":{"id":"edzdryggy3455"},"description":"ID of the pre-existing LIS, which for now will be the external_id. Note: If the line item selector ID is invalid, the system will skip that line item filter and create the other line item filters with valid LIS IDs."},"processing_method":{"type":"string","x-stoplight":{"id":"o2c8wu4tw52oj"},"description":"The processing method for a line item filter determines how the selected items are handled when applying a discount. The system will skip the line item filter if the value of `processing_method` is invalid. The available processing methods are:\n* max_price: Applies the discount to the item with the highest price\n* min_price: Applies the discount to the item with the lowest price\n* exclude: Excludes the selected items from the discount\n* sum_of_amount (default): Applies the discount based on the total sum of the selected items' prices"},"quantity":{"type":"integer","x-stoplight":{"id":"um20q1tdltn1e"},"description":"Specifies how many units of a particular item will be selected or filtered for processing. A value is required if the processing function is selected as `min_price` or `max_price`. If you apply a filter on certain items and specify the quantity, the system will process only the selected number of units for that item. For example, if the quantity is set to 3, only 3 units of the item will be included in the filter or discount. The quantity value must adhere to certain rules:\n* The value of quantity must be a whole number.\n* The quantity cannot be negative.\n* You must have at least 1 unit of the item.\n* You can select up to 5 units of an item."}}}},"qc_item_qualifiers_input":{"title":"QC Input - Item Qualifiers (Array Object)","x-stoplight":{"id":"0ndlcqae60ta6"},"type":"array","description":"Lists the items that must be present on the check to meet the qualification criteria. The processing function is triggered only if the receipt satisfies all of the conditions specified in the object’s attributes.\n\nNote: When updating item qualifiers, do not pass this object in the request if you do not want to update `item_qualifiers`. If an empty array object [] is provided, all previously created item qualifiers will be deleted.\n","items":{"x-stoplight":{"id":"00actsh3la2si"},"type":"object","properties":{"line_item_selector_id":{"type":"string","x-stoplight":{"id":"4mde2pc3va6oh"},"description":"ID of the pre-existing LIS, which for now will be the external_id. Note: If the line item selector ID is invalid, the system will skip that line item filter and create the qualification criteria with valid LIS IDs."},"expression_type":{"type":"string","x-stoplight":{"id":"pjstvek2o5biq"},"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."},"net_value":{"type":"number","x-stoplight":{"id":"d68bi9o1cvp14"},"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 the `expression_type` is set to either \"line_item_exists\" or \"line_item_does_not_exist\", the `net_value` will be ignored and treated as null, even if a value is provided."}}}},"receipt_qualifiers":{"title":"Receipt Qualifiers (Array Object)","x-stoplight":{"id":"p6nqib79s2g8r"},"type":"array","description":"Lists the receipt rules that are used to check for information that must (or must not be) present on a guest's receipt in order to satisfy conditions for the qualification criteria","items":{"x-stoplight":{"id":"kgjrbgyv7mz22"},"type":"object","properties":{"attribute":{"type":"string","x-stoplight":{"id":"ajdryi5buq4al"},"description":"Type of receipt attribute based on which the qualification criteria will be applied. The value of the attribute must be from the predefined list. The system will ignore the attribute value if it is not from the list. If the same attribute is provided multiple times, only the first one will be accepted. Possible values: total_amount, receipt_hour, receipt_week_day, receipt_day, subtotal_amount, receipt_month, receipt_year, revenue_code, revenue_id, employee_id, employee_name, receipt_week, receipt_minute, channel, and transaction_no. For more information on possible values, see the [Receipt Rules/Qualifiers]( https://support.punchh.com/s/article/Receipt-RulesQualifiers) article on the Support Portal. \n\nNote: To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions [here](https://support.punchh.com/s/article/How-do-I-access-the-Punchh-Support-Portal-Single-Sign-On) to access the Punchh Support Portal."},"operator":{"type":"string","x-stoplight":{"id":"rhkpkekle3d65"},"description":"Defines the comparison logic that will be applied to the receipt attribute. 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":"qx6654qjwgumt"},"description":"A specific value or set of values with which the receipt attribute will be compared"}}}}}}}}}