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: objectProperties: 2Required: 2
Food ServicePoint-of-SaleRestaurantHospitality
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.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/toast/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",
"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"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.