Punchh · JSON Structure

Online Ordering Online Order Redemption Request Structure

OnlineOrderRedemptionRequest schema from PAR Punchh Online Ordering and SSO API

Type: object Properties: 7 Required: 7
RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

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

Properties

client discount_type receipt_amount receipt_datetime store_number subtotal_amount transaction_no

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-request-structure.json",
  "name": "OnlineOrderRedemptionRequest",
  "description": "OnlineOrderRedemptionRequest schema from PAR Punchh Online Ordering and SSO API",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "description": "Business client key.",
      "example": "business_client_key"
    },
    "discount_type": {
      "type": "string",
      "enum": [
        "reward",
        "card_completion",
        "redeemable",
        "discount_amount",
        "redemption_code",
        "subscription"
      ],
      "example": "reward"
    },
    "receipt_amount": {
      "type": "double",
      "description": "Order total before taxes.",
      "example": "example"
    },
    "receipt_datetime": {
      "type": "string",
      "description": "ISO 8601 timestamp (YYYY-MM-DDThh:mm:ssZ).",
      "example": "2025-03-15T14:30:00Z"
    },
    "store_number": {
      "type": "string",
      "description": "Redemption location.",
      "example": "STORE-001"
    },
    "subtotal_amount": {
      "type": "double",
      "description": "Pre-tax order amount.",
      "example": "example"
    },
    "transaction_no": {
      "type": "string",
      "description": "Receipt/transaction identifier.",
      "example": "TXN-784512"
    }
  },
  "required": [
    "client",
    "discount_type",
    "receipt_amount",
    "receipt_datetime",
    "store_number",
    "subtotal_amount",
    "transaction_no"
  ]
}