You can use the Toast loyalty program integration API to integrate your loyalty program with the Toast platform. When you use the loyalty program integration, the Toast POS app sends information about guest checks and payments to your loyalty program. Your loyalty program uses the guest check information to accrue rewards and then responds with information about any program rewards that are available. Your loyalty program is responsible for determining the rewards available and the rewards accrued based on the guest check information you receive.
The following list describes the high-level interaction between the Toast platform and your loyalty program when you use the loyalty program integration API.
-
Guests provide a form of identification for a loyalty program account during a Toast POS payment. In some cases, the guest might not have an existing account and intends to sign up for an account. The way that the guest enters the identification depends on the configuration of the Toast POS location and the features of the integrated loyalty program. For example, an employee might enter a guest telephone number in a Toast POS device or a guest might enter an email address as an identifier while using a Toast kiosk device or the Toast POS guest-facing display.
-
If the identifier a guest provides does not match an existing loyalty account, the payment workflow can continue without a loyalty transaction. If the loyalty integration for the Toast POS location is configured to sign up unrecognized guests, it will send guest sign-up information to the loyalty program.
-
If the identifier a guest provides matches an existing loyalty account, rewards that are available are displayed along with a Redeem button. The loyalty program determines how rewards can be redeemed.
-
The employee or guest selects rewards to redeem. The reward appears as a negative amount in the check price.
-
The Toast platform sends information about the check to the integrated loyalty program. Your loyalty program determines how the guest accrues rewards based on the check information. Accruing rewards happens asynchronously (separately from the loyalty integration API requests) after the guest pays the check.
Loyalty program rewards can apply either check-level or item-level discounts. Your integrated loyalty program manages all validation logic and rewards configuration. For more information, see Designing integration business logic.
Your loyalty program must provide information about how to use your program to the Toast POS locations you work with. For example, you must provide reporting on rewards redeemed and sales information related to those offers.
|
Note |
|
Toast loyalty integration API integrations are not supported when a Toast POS location experiences an Internet outage or other network disruption. When a location does not have a functioning network, it is in offline mode. For more information, see Offline mode overview. |
|
Note |
|
Guest balances in the Toast Loyalty loyalty program cannot be retrieved using the Toast loyalty integration API. The Toast Loyalty product is not an integration and does not use the loyalty integration API. |