Punchh · JSON Structure

Online Ordering Online Order Checkin Request Structure

OnlineOrderCheckinRequest schema from PAR Punchh Online Ordering and SSO API

Type: object Properties: 12 Required: 8
RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

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

Properties

client external_uid payable receipt_amount receipt_datetime store_number subtotal_amount transaction_no authentication_token cc_last4 channel employee_id

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-checkin-request-structure.json",
  "name": "OnlineOrderCheckinRequest",
  "description": "OnlineOrderCheckinRequest schema from PAR Punchh Online Ordering and SSO API",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "description": "Business client key.",
      "example": "business_client_key"
    },
    "external_uid": {
      "type": "string",
      "description": "Unique transaction identifier to prevent duplicates.",
      "example": "500123"
    },
    "payable": {
      "type": "double",
      "description": "Final amount after discounts, taxes, and fees.",
      "example": "example"
    },
    "receipt_amount": {
      "type": "double",
      "description": "Order subtotal used for loyalty calculations.",
      "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": "Location identifier.",
      "example": "STORE-001"
    },
    "subtotal_amount": {
      "type": "double",
      "description": "Same as receipt_amount.",
      "example": "example"
    },
    "transaction_no": {
      "type": "string",
      "description": "Receipt/transaction number.",
      "example": "TXN-784512"
    },
    "authentication_token": {
      "type": "string",
      "description": "User auth token.",
      "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
    },
    "cc_last4": {
      "type": "string",
      "description": "Last 4 card digits.",
      "example": "example"
    },
    "channel": {
      "type": "string",
      "enum": [
        "pos",
        "web",
        "online_order",
        "mobile",
        "dashboard",
        "chatbot",
        "kiosk"
      ],
      "example": "pos"
    },
    "employee_id": {
      "type": "string",
      "description": "Employee or system ID.",
      "example": "500123"
    }
  },
  "required": [
    "client",
    "external_uid",
    "payable",
    "receipt_amount",
    "receipt_datetime",
    "store_number",
    "subtotal_amount",
    "transaction_no"
  ]
}