This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
To apply a check to a loyalty program account, include an
AppliedLoyaltyInfo
object in the Check
object.
The AppliedLoyaltyInfo
object includes the following
information:
-
loyaltyIdentifier
- The identifier of the loyalty program account. For example, the customer's loyalty card number. -
vendor
- The identifier of the loyalty program service provider. Thevendor
value is usuallyINTEGRATION
.
The following example shows a check being applied to a loyalty program account.
{ "entityType": "Order", "diningOption": { "guid": "4f4d2103-2e0f-45d7-ae4c-8a9c16648fd1", "entityType": "DiningOption" }, "checks": [ { "entityType": "Check", "customer": { "email": "fgauthier@example.com", "firstName": "Francis", "lastName": "Gauthier", "phone": "987-654-3210" }, "appliedLoyaltyInfo": {"loyaltyIdentifier": "6000101001599474",
"vendor": "
MYLOYALTYPROVIDER
"}, "selections": [ { "entityType": "MenuItemSelection", "itemGroup": { "guid": "eeebddd6-6556-4c81-bd2b-1d1a1a716a83", "entityType": "MenuGroup" }, "item": { "entityType": "MenuItem", "guid": "79df2dfb-340d-405f-a0f9-55b882606ce5" }, "quantity": 3, "modifiers": [] } ] } ] }
The |
|
The |
|
The |