> For the complete documentation index, see [llms.txt](https://docs.boomerangme.cards/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.boomerangme.cards/integrations/toast-pos.md).

# Toast POS

Setting Up the Toast Integration (General guide)

This article explains how to connect Toast to Boomerangme. This is the main, general guide. After connecting the integration, you also need to set up the loyalty card itself — there are separate articles for each card type: [Stamp](/cards-creation/stamp.md), [Reward](/cards-creation/reward.md), [Discount](/cards-creation/discount.md), [Cashback](/cards-creation/cashback.md), [Membership](/cards-creation/membership.md).<br>

*the video shows the same steps described below in text. You can watch the video or read the article — whichever works better for you.*

#### Before you start

> ⚠️ For the integration to work, the restaurant's Toast account needs access to third-party integrations — the **Restaurant Management Suite** (about $50/month, gives access to 200+ Toast partners). This is a Toast requirement, not a Boomerang one. If this isn't purchased, the integration won't work.

A video from Toast on how to buy this subscription: <https://www.youtube.com/watch?v=rvyWMljrbjY>

### Step 1. Connect Boomerang in Toast

1. In Toast, go to **Integrations → Browse & purchase integrations**.
2. Search for **Boomerang →** **Add now**.
3. You'll see the **"Manage your Boomerang integration"** page — here you choose which location(s) you're giving permission to connect.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FVxgVxaeGMZtRat6BKzlA%2Fimage.png?alt=media&amp;token=363267bb-ced0-4374-80d2-047b052ccae7" alt=""><figcaption></figcaption></figure>

4. Click the locations field — the **Select locations** window opens, where you can pick one or more locations (or a whole location group).&#x20;

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FzTRnDSPHtlzSFerKruQy%2Fimage.png?alt=media&amp;token=5eb7b931-4302-4ee1-9994-26a44d496268" alt=""><figcaption></figcaption></figure>

5. Click **Select location.** After that, a form will appear asking you to agree to the terms and conditions; you must accept them.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2F181orKwR3l6m4kFhS3GN%2Fimage.png?alt=media&amp;token=36e9600a-70db-453d-8c43-e3beb2829d68" alt=""><figcaption></figcaption></figure>

After this, the integration will appear in your **My Integrations** list — this means Toast and Boomerang now have permission to exchange data. Nothing else needs to be done on this page.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FWIoGpO073teMcz3rhFMS%2Fimage.png?alt=media&amp;token=b002d972-c893-47b2-b045-7963cee86b01" alt=""><figcaption></figcaption></figure>

### Step 2. Turn on rewards on the POS

For rewards set up in Boomerang to show up on the POS terminal, you need to turn this on separately in Toast:

1. Open **Rewards Program** (in Toast, this is under Marketing → Loyalty).
2. **Enable Loyalty** — select **Yes**. This turns on the Rewards button on the POS terminal.
3. Click **Save**. ❗ Be sure to click "Publish Changes."

> ❗ If you skip this step, rewards won't show up on the POS terminal, even if the integration is connected.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FLJDz4IgigMGzVpORL1pN%2Fimage.png?alt=media&amp;token=551b5c3a-1f43-4f19-ad7d-65b2ed9fe35c" alt=""><figcaption></figcaption></figure>

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FwssSiho4U5Q2kiQGighD%2Fimage.png?alt=media&amp;token=e57a5d0e-93ba-48e0-9177-91f5e71bd621" alt=""><figcaption></figcaption></figure>

### Step 3. Check that menu items are visible

For point-earning rules based on specific products to work correctly, menu items need these visibility settings turned on:

* **POS**
* **Kiosk, Toast Order and Pay**
* **Toast Online Ordering, Local by Toast App**

You'll find these toggles both at the menu level (**Manage Menus → \[menu] → Visible To**) and at the individual item level (**Channel visibility**, when creating or editing an item). Other options (Customer invoices, Online ordering partners) are optional — they don't affect how the integration works.

Click **Save**. ❗ Be sure to click "Publish Changes."

<div align="left"><figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2Fs7OfTAHq347XYIMjwMIE%2Fimage.png?alt=media&amp;token=98b0b839-dc69-455d-94a2-5b8f7ca1e746" alt=""><figcaption></figcaption></figure></div>

<div align="right"><figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FILc6uwebiDgMTdnptZQU%2Fimage.png?alt=media&amp;token=6e2346ae-4625-4d2f-a2fc-b461a74b9784" alt=""><figcaption></figcaption></figure></div>

ℹ️ After making changes, always click **Save**, then **Publish all changes** — otherwise the changes won't take effect.

### Step 4. Check your employees

Under **Employees**, make sure there are employees who have access to the POS terminal.

* You can add a new employee (**Add New Employee**) and assign them a role.
* Every employee has a **POS access code** — a short numeric code (3–8 digits) used to log into the Toast POS app. Code login can be turned off, but that's up to the restaurant owner.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FvwQAd91utu7GpY4syv1b%2Fimage.png?alt=media&amp;token=e8c4609e-7be7-4cbe-b5c1-eecef47fd61e" alt=""><figcaption></figcaption></figure>

### Step 5. Get the location's GUID

> ℹ️ To connect in Boomerang, you'll need a special location identifier from Toast called a **GUID**. This is not the same as the **Restaurant ID** — they're easy to mix up, but you need the GUID for this step.

You can get it two ways:

1. Ask your Toast account manager — they can give you the GUID for each location.
2. Find it yourself: click the current location's name at the top of the page (next to the Toast logo) — a list of locations opens. Hover over the location you need — a link appears in the bottom-left corner of the browser, containing a `guid=...` parameter. That part of the link (the letters and numbers after `guid=` and before `&`) is the identifier you need.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FVLBmDPOhwDXOwFNs58Lx%2Fimage.png?alt=media&amp;token=9913c2fe-b102-48f9-bac6-6f294c721df9" alt=""><figcaption></figcaption></figure>

> ℹ️ If you have more than one location, each one has its own unique GUID.

### Step 6. Connect the integration in Boomerang

The integration is connected from the business owner's account (sub-account), not from the agency account.

> ⚠️ Log in to the sub-account through the domain [**https://app.boomerangme.com/**](https://app.boomerangme.com/). If you log in through a different domain/address, the Toast integration won't appear in the list.

1. Open **Settings → Integrations →** block **Add Integration**
2. Find **Toast** in the list and click **Connect**.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FuAkHkMsEcb8MdXEciJG2%2Fimage.png?alt=media&amp;token=4a924324-f6d2-4722-a154-9edbcae7609c" alt=""><figcaption></figcaption></figure>

3. In the **Integration configuration** window that opens:

* Choose the loyalty card you want to connect.
* Paste the location's GUID into the **"Restaurant ID"** field. Click **Submit**.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FbjpEKvL92Ta57K55R6s3%2Fimage.png?alt=media&amp;token=d47742bb-e393-4cb3-9d62-1efb7aff2088" alt=""><figcaption></figcaption></figure>

❗ Even though the field is called **"Restaurant ID,"** you need to paste the **GUID** from Step 5 here — not the numeric Restaurant ID from Toast. If you copied the whole link, make sure to remove everything except the GUID itself (format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`) — no `?guid=` at the start, and no `&returnUrl=...` at the end. Extra characters or spaces will cause an error.

If everything is entered correctly, the integration will appear under **Active integrations** with status **Active**, linked to the card you chose.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FLOtwnLTYMO8FMnt2uLDy%2Fimage.png?alt=media&amp;token=7bb7ace4-80c0-410e-a8d4-c38cbd381843" alt=""><figcaption></figcaption></figure>

#### Multiple locations

If you have more than one restaurant location, repeat Steps 5–6 for each one separately: get that location's GUID → connect it with its own **Connect** click using that GUID. The same loyalty card can serve several locations at once. You don't have to connect every location right away — you can add them one at a time, whenever it's convenient.

#### What's next

The integration setup itself is now done. Next, you need to set up the loyalty card itself — the point-earning rules and rewards. This is covered in separate articles for each card type:

* Reward card&#x20;
* Stamp card
* Discount card
* Cashback card
* Membership card
