Toast · Schema

LoyaltyDetails

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.

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name	Type	Description
vendor	string	The specific loyalty program service provider that supports the loyalty account.
referenceId	string	The identifier of the loyalty program discount that is recognized by the loyalty program service provider. The Toast platform transmits the discount identifier to the service provider to determine the

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/orders-loyalty-details-schema.json",
  "title": "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",
  "required": [
    "vendor",
    "referenceId"
  ],
  "properties": {
    "vendor": {
      "type": "string",
      "description": "The specific loyalty program service provider that supports the loyalty account.",
      "enum": [
        "TOAST",
        "PUNCHH",
        "PUNCHH2",
        "PAYTRONIX",
        "APPFRONT",
        "INTEGRATION"
      ]
    },
    "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"
    }
  }
}