Redeemable Input (Object)

data
Type: array object[]
required

A list of redeemables that needs to be created
- external_id
  Type: string
  required
  
  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:
  
  Alphanumeric hexadecimal with length 40: 875a6a33ed0f2410d8ac671c2d07c9351ca2f88e
- name
  Type: string
  required
  
  Name of the redeemable
- receipt_rule
  Type: object
  required
  
  Set of rules or conditions that determine how and when an offer can be redeemed
- activate_now
  Type: boolean
  
  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
- allow_for_support_gifting
  Type: boolean
  
  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
- alternate_locale_description
  Type: array object[] · Alternate Locale Description (Array Object)
  
  An object representing the redeemable description in multiple languages
- alternate_locale_name
  Type: array object[] · Alternate Locale Name (Array Object)
  
  An object representing the redeemable name in multiple languages
- applicable_as_loyalty_redemption
  Type: boolean
  
  Indicates whether this redeemable is available for redemption using loyalty points. Possible values: true, false
- auto_applicable
  Type: boolean
  
  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.
- available_as_template
  Type: boolean
  
  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
- description
  Type: string
  
  Description of the redeemable
- discount_channel
  Type: string
  
  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".
- distributable
  Type: boolean
  
  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
  
  Indicates whether the redeemable will be available to all loyalty guests. This parameter is applicable when the business has enabled deals.
- effective_location
  Type: string
  
  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:<punchh_location_id>”. If a location group needs to be selected, use the format "tag:<location_group_id>”.
- end_time
  Type: string
  
  Local date and time at which the offer ends
- expire_redemption_code_with_reward_end_date
  Type: boolean
  
  Indicates whether the redemption code expires on the reward's end date. Possible values: true, false
- expiry_days
  Type: integer
  
  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.
- indefinetely
  Type: boolean
  
  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
- lag_duration
  Type: object · Lag Duration (Object)
  
  This object specifies the duration before the redeemable is gifted to the guest.
- meta_data
  Type: string
  
  Custom information for the offer that the mobile app can use to implement specific filtering logic
- note
  Type: string
  
  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.
- points
  Type: integer
  
  Number of points required to redeem the offer
- recurrence_schedule
  Type: object · Recurrence Schedule (Object)
  
  Specifies how many times this redeemable should be awarded to the guest, along with the frequency
- redemption_code_expiry_mins
  Type: integer
  
  Number of minutes before the redemption code attached to this redeemable expires
- remind_before
  Type: integer
  
  Day(s) before the offer expires, as specified in expiry_days, when the system sends a reminder if the offer has not been used
- segment_definition_id
  Type: integer
  
  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.
- start_time
  Type: stringFormat: date-time
  
  Local date and time at which the offer starts
- template
  Type: object · Template (Object)
  
  This object contains customizable messaging for the redemption process.
- timezone
  Type: string
  
  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