Introduction

The goal of this document is to summarize the onboarding process for Zuppler in-store loyalty with Brink. The document also outlines a few key configuration points to keep in mind to ensure the functionality of the loyalty plan works as designed.

Brink Staging Creds
https://admin-apiint.brinkpos.net/SettingsEditor/
Jacob@zuppler.com
Zuppler32!

Contacting Brink

When you are implementing new customers, we first need to have the client enabled to have the generic loyalty option, which can be done by sending an email to  api.support@partech.com.

When reaching out to api.support@partech.com we should provide them with the following:

• Client Name

• API URL (As found in the Brink POS Configuration)

• Location Key (As found in the Brink POS Configuration)

• Access Token (As Found in the Brink POS Configuration)

Configuring the Loyalty Integration in Brink

Once the Brink API Support team has confirmed that they have enabled the generic loyalty option, we will need to provide the client with the following credentials to configure within their Brink backend:

• Type

  • Generic

• Allow Brink Customer Usage

  • Enabled

• Endpoint URL

  • https://zuppler-loyalty-api.zuppler.com (This is static and will be the same for all clients.)

• Api Key

  • 813de62ea80d330e2db45272769457qw (This is a static key and will be the same for all clients.)

• Store ID

  • This is the remote_ID that is configured for the client in the Preview Channel. (NOTE: If this does not match it will not work.)

• Default Discount

  • ZupplerDiscount

Steps To Configure In Brink

1. Have the Client Log into their Brink backend.

2. In the Navigation bar on the left, expand ‘Configuration’ and select ‘Integrations Portal’.
   

3. Once on the integrations page, select ‘Generic’ under ‘Loyalty’.
   

4. Configure Loyalty Settings and hit ‘Save’.
   

Instore Loyalty Flow With Brink

Customer Lookup
Once the integration is enabled on Brink’s end, the account will see a ‘customer lookup’ tab on their POS system.

On this tab the will have one of the following three options to select from:
-Lookup Customer - This is what will allow them to input the customers information to send the request over to us. NOTE: Always have your client use the ‘email’ option when looking up a user. Brink will reject the response if more than one customer is returned. Since ‘email’ is a unique value in our system, we should use this  as the customer lookup option.
-Redeem Rewards - This will only become a valid request if there is already a user who has been looked up. This will return the rewards available and allow the restaurant to add a reward to the order, if they decided not to with the initial request.
-Clear Customer -  This will remove a customer from the current order if needed.

Redeem Reward
There are two ways to redeem a reward with Brink.
- The first way is during the ‘lookup customer’ call. Once a customer is looked up, we return their current point balance, as well as any available rewards. The restaurant can either select the reward the  user would like to use, or they can exit out of that modal if the user decides to not apply a reward.

- The second way they can redeem a reward is by selecting the ‘Redeem Rewards’ option. This would be used if the customer decided they did not want to apply anything up front but changed their mind later in the ordering process (before checking out).

Earning Points

All earning rules and bonus rules in the Zuppler loyalty plan will be honored when a user places an order instore via the Brink POS system. 

NOTE: If an account is using category level bonus rules, then they need to make sure that the category that is configured in our loyalty plan is configured in the ‘revenue center’ in Brink. The associated items (from Brink) then need to be assigned to that revenue center that was created.

Configuration -> Settings Editor -> Revenue Centers


Instore Loyalty Video Recordings & Logs
User Email Lookup
Display the guest name on the Order
redo the 'Redeem rewards'
Remove a user from being assigned to the order
Displays the loyalty users "Rewards" available to redeem
Displays the loyalty user's current Points Balance
Not displaying phone number or email (on order)
Redeem a single offer
Brink discount with Loyalty discount
Voiding an offer, guest cancels order
Transaction/order close Details

Invalid Phone number/guest
Offline Error
Failed redemption on validation