Toast · JSON Structure

Orders Loyalty Details Structure

Information about the loyalty program discount that is applied to a check. The loyalty program account is identified in the `AppliedLoyaltyInfo` value for the check.

Type: object Properties: 2 Required: 2
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

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

Properties

vendor referenceId

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/toast-tab/refs/heads/main/json-structure/orders-loyalty-details-structure.json",
  "name": "LoyaltyDetails",
  "description": "Information about the loyalty program discount that is applied to a check. The loyalty program account is identified in the `AppliedLoyaltyInfo` value for the check.",
  "type": "object",
  "properties": {
    "vendor": {
      "type": "string",
      "description": "The specific loyalty program service provider that supports the loyalty account.",
      "enum": [
        "TOAST",
        "PUNCHH",
        "PUNCHH2",
        "PAYTRONIX",
        "APPFRONT",
        "INTEGRATION"
      ],
      "example": "TOAST"
    },
    "referenceId": {
      "type": "string",
      "description": "The identifier of the loyalty program discount that\nis recognized by the loyalty program service provider.\n\nThe Toast platform transmits the discount identifier to the service\nprovider to determine the validity and amount of the discount.\n",
      "example": "90a86f12"
    }
  },
  "required": [
    "vendor",
    "referenceId"
  ]
}