Discount Details (Object)

List of a discount's defining attributes. In the case of the Auto Redemption and Get Active Discount Basket APIs, the object returns a null value for invalid discounts.

auto_select
Type: boolean

Whether the offer is enabled for auto-redemption or not. Possible values: true, false
base_amount
Type: integer

Discounted value
campaign_name
Type: string

Name of the campaign through which the guest received the offer
created_at
Type: stringFormat: date-time

Date/time when the reward was created, in YYYY-MM-DDThh:mm:ss format
description
Type: string

Description that explains rewards as configured in the Punchh platform.

The description value is returned in the language specified in the Accept-Language request header, provided the descriptions of redeemable and subscription have been translated into the relevant language in the Punchh platform. If the translation is unavailable, the response returns the value for this parameter in the default English language. For example, if the header specifies “fr” (French), the description is returned in French only if a French translation is configured for the description in the Punchh platform; otherwise the value is returned in the default English language.
end_date_tz
Type: stringFormat: date-time

Expiry date of the reward in ISO 8601 format
image
Type: string

Image URL of the reward
item_id
Type: integer

Item ID
item_properties
Type: string

Comma-separated values that provide additional details about a redeemable. For example, a redeemable could be a "Food_Item" or "Merchandise", etc. Can be configured for a business in the Punchh platform and attached to a redeemable. If no value is attached to a redeemable, a blank field will be returned.
max_applicable_quantity
Type: integer

The maximum quantity that can be discounted. Note: This parameter is returned for offers related to Price Rollback, Target Price for Bundle, and Target Price for Bundle (Advanced).
meta_detail
Type: string

Meta information configured for discount_type values: redemption_code, subscription, reward, and redeemable. The response returns a value only if the meta data field is configured in the Punchh platform when creating the discount. Currently, the Punchh platform supports multilingual values for meta_detail only for coupon redemption.

The meta_detail value for the coupon redemption (i.e., when discount_type = redemption_code) is returned in the language specified in the Accept-Language request header, provided the coupon meta data has been translated into the relevant language in the Punchh platform. If the translation is unavailable, the response returns the value for this parameter in the default English language. For example, if the header specifies “fr” (French), the meta_data value for a coupon is returned in French only if a French translation is configured for the coupon meta data in the Punchh platform; otherwise the value is returned in the default English language.
name
Type: string

External discount name.

The name value is returned in the language specified in the Accept-Language request header, provided the redeemable name and subscription plan name have been translated into the relevant language in the Punchh platform. If the translation is unavailable, the response returns the value for this parameter in the default English language. For example, if the header specifies “fr” (French), the name is returned in French if a French translation is configured for the name in the Punchh platform; otherwise the value is returned in the default English language.
points
Type: integer

Points associated with the current reward
start_date_tz
Type: stringFormat: date-time

Start date of the reward in ISO 8601 format

Examples

[
  {
    "item_id": 777658,
    "name": "Flat $5 Off (Unlocks at 100 points)",
    "image": "IMAGE_URL_GOES_HERE",
    "points": 100,
    "base_amount": 5,
    "description": "",
    "item_properties": null,
    "meta_detail": null,
    "start_date_tz": null,
    "end_date_tz": null,
    "created_at": "2022-09-08T18:41:16Z"
  }
]

Discount Basket Items (Array Object)

Line Items (Array Object)