Punchh · Schema

PosUser

PosUser schema from PAR Punchh POS and Kiosk API

RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

Properties

Name Type Description
phone_number string
email string
first_name string
last_name string
card_number string
balances object Loyalty point and reward balances.
View JSON Schema on GitHub

JSON Schema

pos-pos-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PosUser",
  "description": "PosUser schema from PAR Punchh POS and Kiosk API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/pos-pos-user-schema.json",
  "type": "object",
  "properties": {
    "phone_number": {
      "type": "string",
      "example": "+15551234567"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "first_name": {
      "type": "string",
      "example": "Jane Smith"
    },
    "last_name": {
      "type": "string",
      "example": "Jane Smith"
    },
    "card_number": {
      "type": "string",
      "example": "example"
    },
    "balances": {
      "type": "object",
      "description": "Loyalty point and reward balances."
    }
  }
}