{"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22~1model~1redeemable_data_input":{"page":{"type":"openapi-model","title":"Redeemable Input (Object)","uid":"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22~1model~1redeemable_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":"redeemable_data_input","ref":"#/components/schemas/redeemable_data_input","navigationId":"dnobvb-xwfx0nmzkftqj9zswo5_eqjnjbihbxm22/model/redeemable_data_input"},"content":{"components":{"schemas":{"redeemable_data_input":{"title":"Redeemable Input (Object)","x-stoplight":{"id":"py6v9pco9txg3"},"type":"object","properties":{"data":{"type":"array","x-stoplight":{"id":"nttkj2ju991hq"},"description":"A list of redeemables that needs to be created ","items":{"x-stoplight":{"id":"eoav6ju4ony0e"},"type":"object","properties":{"name":{"type":"string","x-stoplight":{"id":"dhp1ab2v5jqc8"},"description":"Name of the redeemable"},"external_id":{"type":"string","x-stoplight":{"id":"on1fi68g1fhnl"},"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"},"alternate_locale_name":{"$ref":"#/components/schemas/redeemable_alternate_locale_name"},"alternate_locale_description":{"$ref":"#/components/schemas/redeemable_alternate_locale_description"},"description":{"type":"string","x-stoplight":{"id":"9g7xc3m4c5ct5"},"description":"Description of the redeemable"},"note":{"type":"string","x-stoplight":{"id":"4kyfgwknzl2iq"},"description":"An internal note provided by the business. This text is not visible in the app and is solely for the business to use internally to store information for future reference."},"allow_for_support_gifting":{"type":"boolean","x-stoplight":{"id":"wwwiin82pahcl"},"description":"Indicates whether the redeemable is available for support gifting. Admins who have gifting permission will be able to gift this redeemable to guests for support purposes. Possible values: true, false"},"available_as_template":{"type":"boolean","x-stoplight":{"id":"ukmib5x5s8x7p"},"description":"Indicates whether the redeemable is available for use as a template. If set to true, the redeemable can be reused and customized for creating new redeemables. Possible values: true, false"},"distributable":{"type":"boolean","x-stoplight":{"id":"1ywcatnlys4ne"},"description":"Indicates whether the redeemable will be available only for guests who validate their segments. This parameter is applicable when the business has enabled deals."},"distributable_to_all_users":{"type":"boolean","x-stoplight":{"id":"cr976gvfywelx"},"description":"Indicates whether the redeemable will be available to all loyalty guests. This parameter is applicable when the business has enabled deals."},"segment_definition_id":{"type":"integer","x-stoplight":{"id":"jg9uh12b3tf04"},"description":"ID of the segment as defined in the Punchh system. A value in the \"punchh-segment-id\" format is required in this parameter if `distributable` is set to true and `distributable_to_all_users` is set to false. This parameter is applicable when the business has enabled deals."},"auto_applicable":{"type":"boolean","x-stoplight":{"id":"cwsnod7d1u9io"},"description":"Indicates whether the offer (gifted and not tied to points) can be automatically redeemed without guest interaction. This is applicable for businesses with auto redemption enabled and for discount types defined in the Auto-Application strategy."},"receipt_rule":{"type":"object","x-stoplight":{"id":"e4go768zliuup"},"description":"Set of rules or conditions that determine how and when an offer can be redeemed","required":["qualifier_type","redeeming_criterion"],"properties":{"qualifier_type":{"type":"string","x-stoplight":{"id":"8iwze6rf494wr"},"description":"Defines the criteria that apply to the processing of receipts, determining how the discount will be applied based on the items purchased. Possible values:\n* new: Specify new if you want to create new qualification criteria to process the offer. If you choose this option, use the parameters in the `redeeming_criterion` object to create a new qualification criteria.\n* existing: Specify existing if you're going to use an existing qualification criteria to process the offer. The UUID of the existing qualification criteria should be specified in the `redeeming_criterion_id` parameter. \n* flat_discount: Specify flat_discount to set a fixed discount for the offer regardless of the items or total amount on the receipt. For example, $50 off or 10% off. The discount value should be specified in the `discount_amount` parameter."},"redeeming_criterion_id":{"type":"string","x-stoplight":{"id":"2oumywxdun122"},"description":"UUID of the qualification criteria you want to attach to the offer. The QC UUID is provided in the `external_id` response parameter when you create qualification criteria using the [Create Qualification Criteria](/docs/dev-portal-platform-functions/009524a9d88ae-create-qualification-criteria-qc) API. A value is required for this parameter when `qualifier_type` is \"existing\"."},"discount_amount":{"type":"number","x-stoplight":{"id":"hsax2zubl1mvv"},"description":"Fixed discount set for the offer that will be applied to the receipt regardless of the items or total amount on the receipt (e.g., $50 off or 10% off). A positive value is required for this parameter when `qualifier_type` is \"discount\".","format":"float"},"redeeming_criterion":{"$ref":"#/components/schemas/redeemable_redeeming_criterion"}}},"activate_now":{"type":"boolean","x-stoplight":{"id":"jafcdzcpiczlx"},"description":"Indicates whether the offer will be activated immediately. This applies when the `distributable` parameter for the offer is set to true, and the business has enabled deals. Possible values: true, false"},"start_time":{"type":"string","x-stoplight":{"id":"8rwolvqehscj6"},"format":"date-time","description":"Local date and time at which the offer starts"},"end_time":{"type":"string","x-stoplight":{"id":"40mlgs55b1679"},"description":"Local date and time at which the offer ends"},"indefinetely":{"type":"boolean","x-stoplight":{"id":"57whtvdh9nhvj"},"description":"Indicates whether the redeemable will be available indefinitely. If set to true, the offer will not expire. If set to false, you can specify the expiry period in the `expiry_days` parameter. Possible values: true, false"},"expiry_days":{"type":"integer","x-stoplight":{"id":"orp6tb0zslwq3"},"description":"Number of days before the reward expires. If the value of this parameter is set to 5 and the reward is credited to a guest’s account before the day ends (i.e., 11:59 PM), that day will be counted as the first day of reward availability. The reward will then expire at 11:59 PM on the fifth day."},"timezone":{"type":"string","x-stoplight":{"id":"lcqztohmx2jsh"},"description":"Valid time zone in which the offer is applicable or active. Possible values: Etc/GMT+12, Pacific/Pago_Pago, Pacific/Midway, Pacific/Honolulu, America/Juneau, America/Los_Angeles, America/Tijuana, America/Phoenix, America/Mazatlan, America/Denver, America/Guatemala, America/Chicago, America/Chihuahua, America/Mexico_City, America/Monterrey, America/Regina, America/Bogota, America/New_York, America/Indiana/Indianapolis, America/Lima, America/Halifax, America/Caracas, America/Guyana, America/La_Paz, America/Puerto_Rico, America/Santiago, America/St_Johns, America/Sao_Paulo, America/Argentina/Buenos_Aires, America/Montevideo, America/Godthab, Atlantic/South_Georgia, Atlantic/Azores, Atlantic/Cape_Verde, Europe/London, Europe/Lisbon, Africa/Monrovia, Etc/UTC, Europe/Amsterdam, Europe/Belgrade, Europe/Berlin, Europe/Zurich, Europe/Bratislava, Europe/Brussels, Europe/Budapest, Africa/Casablanca, Europe/Copenhagen, Europe/Dublin, Europe/Ljubljana, Europe/Madrid, Europe/Paris, Europe/Prague, Europe/Rome, Europe/Sarajevo, Europe/Skopje, Europe/Stockholm, Europe/Vienna, Europe/Warsaw, Africa/Algiers, Europe/Zagreb, Europe/Athens, Europe/Bucharest, Africa/Cairo, Africa/Harare, Europe/Helsinki, Asia/Jerusalem, Europe/Kaliningrad, Europe/Kiev, Africa/Johannesburg, Europe/Riga, Europe/Sofia, Europe/Tallinn, Europe/Vilnius, Asia/Baghdad, Europe/Istanbul, Asia/Kuwait, Europe/Minsk, Europe/Moscow, Africa/Nairobi, Asia/Riyadh, Europe/Volgograd, Asia/Tehran, Asia/Muscat, Asia/Baku, Asia/Tbilisi, Asia/Yerevan, Asia/Kabul, Asia/Almaty, Asia/Yekaterinburg, Asia/Karachi, Asia/Tashkent, Asia/Kolkata, Asia/Colombo, Asia/Kathmandu, Asia/Dhaka, Asia/Urumqi, Asia/Rangoon, Asia/Bangkok, Asia/Jakarta, Asia/Krasnoyarsk, Asia/Novosibirsk, Asia/Shanghai, Asia/Chongqing, Asia/Hong_Kong, Asia/Irkutsk, Asia/Kuala_Lumpur, Australia/Perth, Asia/Singapore, Asia/Taipei, Asia/Ulaanbaatar, Asia/Tokyo, Asia/Seoul, Asia/Yakutsk, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Melbourne, Pacific/Guam, Australia/Hobart, Pacific/Port_Moresby, Australia/Sydney, Asia/Vladivostok, Asia/Magadan, Pacific/Noumea, Pacific/Guadalcanal, Asia/Srednekolymsk, Pacific/Auckland, Pacific/Fiji, Asia/Kamchatka, Pacific/Majuro, Pacific/Chatham, Pacific/Tongatapu, Pacific/Apia, Pacific/Fakaofo"},"remind_before":{"type":"integer","x-stoplight":{"id":"hflasli2nhjiu"},"description":"Day(s) before the offer expires, as specified in expiry_days, when the system sends a reminder if the offer has not been used"},"discount_channel":{"type":"string","x-stoplight":{"id":"crt1xpyf0hjdm"},"description":"Channels where this redeemable can be discounted. The value of this parameter is for informational purposes only and is not validated by Punchh. Third-party vendors can use this information to show/hide the redeemable on their platform. Possible values: all, online_only, offline_only. The default value is \"all\".","default":"all"},"points":{"type":"integer","x-stoplight":{"id":"rfr7tjv089bwv"},"description":"Number of points required to redeem the offer"},"redemption_code_expiry_mins":{"type":"integer","x-stoplight":{"id":"n8sh4g00qgwn3"},"description":"Number of minutes before the redemption code attached to this redeemable expires"},"applicable_as_loyalty_redemption":{"type":"boolean","x-stoplight":{"id":"qypwkih83qkqg"},"description":"Indicates whether this redeemable is available for redemption using loyalty points. Possible values: true, false"},"expire_redemption_code_with_reward_end_date":{"type":"boolean","x-stoplight":{"id":"i4ixpihm4qe4n"},"description":"Indicates whether the redemption code expires on the reward's end date. Possible values: true, false"},"template":{"$ref":"#/components/schemas/redeemable_template"},"lag_duration":{"$ref":"#/components/schemas/redeemable_lag_duration"},"recurrence_schedule":{"$ref":"#/components/schemas/redeemable_recurrence_schedule"},"effective_location":{"type":"string","x-stoplight":{"id":"7puasc43k08ca"},"description":"A valid or existing location ID or location group ID. The default value is null. Restricts redemption to the specified location(s). If a specific location needs to be specified, use the format \"location:”. If a location group needs to be selected, use the format \"tag:”."},"meta_data":{"type":"string","x-stoplight":{"id":"x7g87ozg95mqi"},"description":"Custom information for the offer that the mobile app can use to implement specific filtering logic"}},"required":["name","external_id","receipt_rule"]}}},"required":["data"]},"redeemable_alternate_locale_name":{"title":"Alternate Locale Name (Array Object)","x-stoplight":{"id":"0xsss0n88vh7u"},"type":"array","description":"An object representing the redeemable name in multiple languages","items":{"x-stoplight":{"id":"fftabdlo3dnth"},"type":"object","properties":{"language":{"type":"string","x-stoplight":{"id":"fuql2d7va5dqn"},"description":"The language code representing the locale. Possible values: en-CY for English (Cyprus), en-GB for English (United Kingdom), es for Spanish, es-CR for Spanish (Costa Rica), es-US for Spanish (United States), fr for French, fr-ca for French (Canada), and ro for Romanian"},"translation":{"type":"string","x-stoplight":{"id":"480v64bn1qnn3"},"description":"The translated name of the redeemable in the specified language"}}}},"redeemable_alternate_locale_description":{"title":"Alternate Locale Description (Array Object)","x-stoplight":{"id":"3y2hqeml324qq"},"type":"array","description":"An object representing the redeemable description in multiple languages","items":{"x-stoplight":{"id":"8szg455tajjof"},"type":"object","properties":{"language":{"type":"string","x-stoplight":{"id":"qasnnev0s3mx0"},"description":"The language code representing the locale. Possible values: en-CY for English (Cyprus), en-GB for English (United Kingdom), es for Spanish, es-CR for Spanish (Costa Rica), es-US for Spanish (United States), fr for French, fr-ca for French (Canada), and ro for Romanian"},"translation":{"type":"string","x-stoplight":{"id":"562siougg25ip"},"description":"The translated description of the redeemable in the specified language"}}}},"redeemable_redeeming_criterion":{"title":"Redeeming Criterion (Object)","x-stoplight":{"id":"jojsfkft1uil5"},"type":"object","description":"This object contains information about the qualification criteria that will be created and attached to the redeemable. It is required when `qualifier_type` is set to \"new\".","properties":{"name":{"type":"string","x-stoplight":{"id":"wkwstergomqnr"},"description":"Name of qualification criteria (QC). The name can be up to 255 characters long.","minLength":0,"maxLength":225},"external_id":{"type":"string","x-stoplight":{"id":"90qxonbnlop6s"},"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":"oxwadpyrf764i"},"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.","format":"float","minimum":0,"maximum":99999},"percentage_of_processed_amount":{"type":"number","x-stoplight":{"id":"xwie3xvrgdw2q"},"format":"float","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":0,"maximum":99999},"qc_processing_function":{"type":"string","x-stoplight":{"id":"w7xhz6u0ksna8"},"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 are 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). \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 Punchh 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."},"rounding_rule":{"type":"string","x-stoplight":{"id":"zoqkuij01oaud"},"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":"kn49zs35liiog"},"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":1},"unit_discount":{"type":"number","x-stoplight":{"id":"k2cfku19gv7ee"},"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 (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, and 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 qualification criteria 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","maximum":99999,"minimum":0.01},"minimum_unit_rate":{"type":"number","x-stoplight":{"id":"p5an5geaz0kka"},"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},"target_price":{"type":"integer","x-stoplight":{"id":"96n35s1vh5b88"},"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."},"effective_location":{"type":"string","x-stoplight":{"id":"0shnef5xs778r"},"description":"A valid or existing location ID or location group ID. The default value is null. Restricts redemption to the specified location(s). If a specific location needs to be specified, use the format \"location:”. If a location group needs to be selected, use the format \"tag:”."},"stack_discounting":{"type":"boolean","x-stoplight":{"id":"vgcyndom3xq2v"},"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":"nlw6bw79udofe"},"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."},"qualifying_expressions_operator":{"type":"string","x-stoplight":{"id":"zhl3mem3g88kn"},"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."},"item_filter_expressions_operator":{"type":"string","x-stoplight":{"id":"55psu44tsnb6d"},"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."},"discount_evaluation_strategy":{"type":"string","x-stoplight":{"id":"4bp3rh2ao6mbu"},"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\"."},"line_item_filters":{"$ref":"#/components/schemas/qc_line_item_filters_input"},"enable_menu_item_aggregator":{"type":"boolean","x-stoplight":{"id":"a0i7wql9fvp37"},"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":{"$ref":"#/components/schemas/aggregator_grouping_attributes"},"item_qualifiers":{"$ref":"#/components/schemas/qc_item_qualifiers_input"},"receipt_qualifiers":{"$ref":"#/components/schemas/receipt_qualifiers"}},"required":["external_id"]},"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."}}}},"aggregator_grouping_attributes":{"title":"Aggregator Grouping Attributes (Object)","x-stoplight":{"id":"iq2opeipfwlcq"},"type":"object","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 a required parameter if `enable_menu_item_aggregator` is sent as true.","properties":{"item_name":{"type":"boolean","x-stoplight":{"id":"0c5b64frkhg7r"},"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":"cwkwcvwpy7dxw"},"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":"3mybqncem0pbp"},"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":"aer4gxjg2oz82"},"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":"lemyxyuixrzyo"},"description":"Indicates whether to group menu items with the same type of menu item together and aggregate their quantities. Possible values: true, false"}}},"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"}}}},"redeemable_template":{"title":"Template (Object)","x-stoplight":{"id":"2jo6kgp0r4h25"},"type":"object","properties":{"redemption_message":{"type":"string","x-stoplight":{"id":"wp8fepiom8yf8"},"description":"Message displayed on the redemption screen of the mobile app during the redemption process. You can use the variables {{points_requested}} and {{redeemed_points}} to customize this message as appropriate."},"short_prompt":{"type":"string","x-stoplight":{"id":"b5vw6z1pcxd5a"},"description":"Prompt message displayed on the Point of Sale and Pin Pad"},"standard_prompt":{"type":"string","x-stoplight":{"id":"lkvmx53k4etc5"},"description":"Prompt message displayed on the Point of Sale and Pin Pad"}},"description":"This object contains customizable messaging for the redemption process."},"redeemable_lag_duration":{"title":"Lag Duration (Object)","x-stoplight":{"id":"y8ihb0cxfl4py"},"type":"object","description":"This object specifies the duration before the redeemable is gifted to the guest.","properties":{"value":{"type":"integer","x-stoplight":{"id":"f6juqmterzqcu"},"description":"Numeric amount representing the duration"},"units":{"type":"string","x-stoplight":{"id":"jj5umrnpyj6so"},"description":"Unit of measurement for the duration. Possible values: days, hours"}}},"redeemable_recurrence_schedule":{"title":"Recurrence Schedule (Object)","x-stoplight":{"id":"oydu0pldcbie3"},"type":"object","description":"Specifies how many times this redeemable should be awarded to the guest, along with the frequency","properties":{"occurrences":{"type":"integer","x-stoplight":{"id":"w5kr0ilaghndd"},"description":"The number of times the redeemable should be awarded to the guest, based on the recurrence interval defined. For example, if set to 2, the guest will receive the reward twice, once for each occurrence as defined by the schedule (e.g., once every 2 days)."},"days_distance":{"type":"integer","x-stoplight":{"id":"a6o1rjybs8wgz"},"description":"Defines the number of days after which the redeemable will be repeated. For example, if set to 2, the redeemable will be awarded again every 2 days. The recurrence days must be between 1 and 395. The total duration for recurrences cannot be greater than 13 months. For example, if the recurrence is set to 3 times every 90 days, the recurrence will be at Day 1, Day 90, and Day 180. However, if the recurrence is set to 6 times every 90 days, then recurrence would be at Day 1, Day 90, Day 180, Day 270, Day 360, and Day 450. This setup would result in an error message appearing in the platform as the total recurrence days are greater than 395 days."}}}}}}}}