Punchh · JSON Structure

Online Ordering Online Order Redemption Response Structure

OnlineOrderRedemptionResponse schema from PAR Punchh Online Ordering and SSO API

Type: object Properties: 7
RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

OnlineOrderRedemptionResponse is a JSON Structure definition published by Punchh, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status redemption_amount category qualified_menu_items discount_distribution_items redemption_id redemption_code

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json",
  "name": "OnlineOrderRedemptionResponse",
  "description": "OnlineOrderRedemptionResponse schema from PAR Punchh Online Ordering and SSO API",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Redemption confirmation message.",
      "example": "active"
    },
    "redemption_amount": {
      "type": "double",
      "description": "Discount value applied.",
      "example": "example"
    },
    "category": {
      "type": "string",
      "description": "Redemption type.",
      "example": "reward"
    },
    "qualified_menu_items": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "discount_distribution_items": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "redemption_id": {
      "type": "int32",
      "example": "500123"
    },
    "redemption_code": {
      "type": "string",
      "example": "CODE-AB12CD"
    }
  }
}