Otter + Revel Integration Guide

Integration Overview

What is a POS integration between Otter and Revel POS?

A POS integration is when you connect your online channels and delivery platforms with your Revel POS, via Otter.

It creates real-time and direct communication between the delivery platforms and Revel, removing most manual inputs and actions required to synchronize those systems.

What is the necessity of integrating your Revel POS with Otter?

When online food orders from Delivery platforms represent a significant part of the business of a restaurant, they start feeling multiple operational pain points, that all find answers and solutions with a POS integration.

Otter’s point-of-sale integration allows orders from your delivery partners to flow directly into your point of sale. This integration has numerous benefits including:

  • Automatically synchronize the Menu from Revel POS to your delivery channels, with no manual actions.
  • Sending all orders to flow directly into your Revel KDS seamlessly.
  • Sending all orders to print using Revel POS printer.
  • Eliminating the manual entry of delivery platform orders into the POS.
  • Improving the quality of the data by reducing errors from manual entry.

In conclusion, an integration with Revel POS can save time and money, on a daily basis, and make your business more successful.

How does the Otter & Revel integration work?

Step 1: Menu Sync

A POS integration with Revel starts by a “Menu Sync” where Otter reads the menu in Revel POS and then links the items in Revel to the items published to the delivery platforms.

Step 2: Order Injection

A POS integration with Otter allows customers to get Online Food Ordering platform orders sent directly to their POS. This means that if you are POS integrated, when you receive an online food order through Otter, the food order will automatically be sent to your Revel POS and be processed by the POS as any other order.

 


 

How to Connect

The process to get the Otter & Revel Integration up and running

  • Step 1: You must add Otter as a user within your Revel environment. You must also request that Revel grants us API access to the back end of the system. Check the articles below.
  • Step 2: You will build your delivery menu in Revel and we will sync the items you create here to your Otter menu, which in turn is synced to your delivery channel menus.
  • Step 3: You will map all items to their preferred printers in Revel.
  • Step 4: At this point, we can turn the integration on and orders will immediately flow into Revel from Otter.

If you don’t have an Otter’s account, you can request a free demo here.
For current customers, in case of doubts, reach out to your Otter POS onboarding specialist.

Grantint Revel API access to Otter

Please send an email to operations@revelsystems.com and cc pos-emea@tryotter.com to request that they grant Otter access to your Revel API with the following information:

  • Client name & email address
  • Business name
  • Revel URL
  • Establishment(s) connecting to the Otter Integration
NOTE: There is an additional fee imposed by Revel for connecting new API integrations to your Revel account. For further information on this fee, please contact Revel Support Center.

Adding Otter User in Revel

In order for Otter to be able to integrate with Revel, once we have API access you will need to add Otter as a user in your POS. The steps to achieve this are below.

How to: Add an Otter User in Revel


 

Step Process Additional Information
1

Add a new role for Otter

On your Management Console [yourdomainname.revelup.com], navigate to Employees and choose Management Console Permissions. You'll see all Roles that have previously been created.

To add a new Role, click + Add at the top of the list.

Step 1 Adding Otter User in Revel.png

Step 1.2 Adding Otter User in Revel.png

2 You will be prompted to enter the Permission Set Name which can be set to Otter Permissions. Step 2 Adding Otter User in Revel.png
3 Select Reports, Products, Establishment, and Settings from the left-hand permissions pane. Step 3 Adding Otter User in Revel.png
4

Activate the Reports permissions for read all, write all and add all as denoted by the arrows above.

Scroll down and make the same selections for Products, Establishment and Settings permissions as they are not automatically selected when setting permissions for Reports.

Don’t forget to hit Save.

Step 4 Adding Otter User in Revel.png
5

Add Otter as an Employee

In the Management Console [yourdomainname].revelup.com], click the Employees tab.

Click + Add and choose Add Employee from the drop-down menu.

Step 5 Adding Otter User in Revel.png
6 Fill out the information for the new employee. The following fields are required:
  • First Name: Otter
  • Last Name: Team
  • Employee Start: today’s date
  • Role: Employee
  • PIN: 1234 (if that's taken, it can be any pin)
  • Username: otter.[yourdomainname]
  • Email Address: pos-emea+[yourdomainname]@tryotter.com
  • Password: Revelup!0000 (we will change this once we get access)
  • Administrative Permissions Set: Otter Permissions (the one that we previously created)
 
7 Once all fields have been filled out, click Save & Close to exit the screen.  

What if I previously worked with another POS integration provider? (e.g. Chowly, It's a Checkmate, Deliverect, OLO)

  • Reach out to the Prior POS integration Provider to remove integrations from all delivery partners. They cannot just be disconnected, they need to be removed or the delivery partners will not let us connect. Please set a specific time to disconnect/remove the Prior POS Integrator and we can immediately launch the Otter integration.
  • Connect with your Delivery Partners to set the “tablet order protocol”. The Prior POS Provider often has you change the order protocol so we’ll need to revert it back to the tablet. The Delivery Partners should be able to confirm/get this done quickly.
  • Similarly, connect with your Delivery Partners to allow us menu edit access on all Delivery Partners.

To confirm, there is no downtime in terms of accepting orders if you follow these steps, and you can have an Order Manager running on the Otter tablet to aggregate those throughout the process. Still, we cannot link/publish to your Delivery Partners until the above steps are followed.

 


 

POS Integration Settings in Otter Dashboard

When you make changes to your POS settings, the changes will need to be reflected in Otter as well to avoid order injection issues. The changes made in your POS can be updated in Otter within the POS Settings of the Otter Dashboard.

Available POS settings in the Otter Dashboard:

  • View all the POS integration parameters set up for each of the stores.
  • Update the POS channel settings under its control for each store. 
    • These are parameters pulled directly from the POS, per integration, based on what you have configured on your POS account.
  • Turn on/off the POS injection per channel.

Examples of those settings are payment ID, dining ID, pickup ID, etc.

Learn how to adjust the POS integration settings here: Third-Party POS Integration Settings

 


 

Menu Management

Menu Best Practices

Before initiating a POS integration with Otter, it's essential to ensure the usability and quality of the Menu in Revel POS.

Best practices include:

  • Add all categories that you would like to have on your delivery channels (UberEats, Doordash, etc.) in the POS.
  • Add all items/item variations/modifiers that do not already exist in Revel precisely as you want the guest to see them on delivery channels.
  • Review and clean the names, descriptions and prices to make sure they are ready to be published to the delivery platforms.

Otter will be synchronized with the delivery platforms' menus so that they will reflect how they are in Revel, giving you the ability to completely control your guests’ experience directly from Revel POS.

How to prepare your Menu in Revel POS?

To begin preparing your delivery menu items in Revel, you can follow the steps below, and then via Otter, we’ll sync the menu items you create with the menu items in your delivery channels. This allows certain item details to be different between your delivery channels and POS system if required.

How to: Prepare a Menu in Revel


 

Step Process Additional Information
1

Create your delivery menu categories

Firstly, you should create a new category in the Products tab in Revel called Otter Menu. We’ll use this name to identify which categories and items we should sync with your delivery channels.

Following that, each category of your delivery menu should be created as a subcategory under the Otter Menu category. If you already have an active menu on a delivery channel, simply recreate those categories here.

Your Otter Menu category in Revel should look similar to the image to the right after completing this step.

Step 1 How to prepare your Menu in Revel POS.png
2

Create your modifier groups

Once your category structure is built, you should create any modifier groups that the items on your delivery menu have applied to them.

To create a modifier group:

  1. Click on Modifiers from the Products page tabs on the left hand side of the screen
  2. Click + Add Modifier Class to add a Modifier Class (modifier group)
  3. Enter a name for the Modifier Class in the corresponding field
    • Please add “CSS - ” to the beginning of the name. This helps us identify which modifier groups to read from when we sync the menu to Otter
  4. Click the save icon to save the Modifier Class
  5. Expand a Modifier Class by clicking the ⊞ icon next to the class name
  6. Click + Add Modifier to create a Modifier option
  7. Enter a name for the Modifier in the "Modifier Class Name" field
  8. Input a cost and price for the modifier, if needed
  9. Click the save icon located in the upper right corner to save the modifier

Your Modifiers list should look similar to the second image to the right when complete.

Step 2.1 How to prepare your Menu in Revel POS.png

Step 2.2 How to prepare your Menu in Revel POS.png

3

Create your menu items and add to categories

Once your categories and modifiers are built, you should create the items that you’re selling on your delivery channels and add them into the relevant categories.

We must have the following information for each item to be able to map reliably to your delivery channel products:

  • Item name
  • Price
  • Category (should be Otter Menu) and subcategory

To add an item to your delivery menu:

  1. Click the Product icon to open up the Products page.
  2. Click + Add in the upper right portion of the screen to open up the new product drop-down menu.
  3. Click Product (Advanced). The product details page will open with the most commonly used product details preselected.
  4. From the Basic Product Details section on the right side of the page, input the item’s name, description, and price.
  5. Scroll down on the right side of the page to the Display/Print Options section.
  6. Select the item’s category and subcategory from the Main category drop-down.
  7. At this stage you can also add additional information such as tax rates and printers, if required. More information on item settings is available here.
  8. When you’ve added all the necessary information for your item, click Save, then Back to Products to return to the Products list.
 
4

Apply your modifier groups to your items

The final step to building your delivery menu is to ensure each item has any relevant modifier groups added to it.

To add a modifier group to an item:

  1. Select the Products tab to access the list of categories.
  2. Navigate to the required item by clicking into your Otter Menu category, then the relevant subcategory.
  3. Click the “M” associated with an item to apply a modifier group to that item.
  4. Navigate to the desired modifier group to attach it to the item.
  5. Click Save in the upper right corner to save changes.
Step 4 How to prepare your Menu in Revel POS.png 

For further instructions on menu building in Revel, please check the Revel Menu Build Guide.

Tips to a perfect Menu Structure

Items
  • Use viewer-friendly menu item names to avoid misunderstanding, for instance, use “Chicken Burger” instead of “C.Burger” or “C.B”.
  • Avoid creating duplicate items across multiple categories.
  • It is highly recommended to have a viewer-friendly description of each item.
Categories
  • Use viewer-friendly menu categories names, for example: Salads, Special Salads, Toppings, Beverage, etc.
Modifier Groups
  • It is recommended to avoid using identical name modifiers groups to prevent confusion or ambiguity.
  • Match the minimum and maximum allowed modifiers with the defined modifier groups on the OFOs' structure for accuracy.
Modifiers
  • Avoid using modifier groups inside other modifier groups, also known as nested modifiers.
  • Avoid using identical name modifiers to prevent confusion or ambiguity.
Photos
  • Make sure to have high-quality photos to feature on the menu. Check this guide to learn more.

Setting up Menu Auto-Sync with Revel POS?

Menu Auto-Sync with Revel POS is the best way to ensure a reliable POS integration with minimal maintenance in the long run. It is a best practice used by most Otter customers to manage their Menus in Revel POS and automate the update of all the other menus in their Delivery Platforms.

Here are the steps to enable Menu Auto-Sync with Revel POS:

How to: Enable Menu Auto-Sync with Revel POS


 

Step Process Additional Information
1 Open your Otter Dashboard, if you don’t have this access, please contact Otter's Customer Support.  
2 Go to the Otter Menus app, and select your menu. Step 2 Enable Menu Auto-Sync.png
3 Click on the Settings icon in the top-right corner. Step 3 Enable Menu Auto-Sync.png
4 Click on the Menu Sync tab enable the "Automatic updates from POS Menu" toggle. Step 4 Enable Menu Auto-Sync.png
5

The automatic menu publish setting will be available only once you configure the Automatic updates from the POS Menu.

Configure the settings by selecting the information you wish Otter to update automatically from the POS.

Step 5 Enable Menu Auto-Sync.png
When Menu Auto-Sync is enabled, it will run every 6 hours, and will ensure the menus are kept synced. Check more details in this article.
NOTE: If you do not automate the menu publishing, Otter will only reflect the updates from the POS on the Otter menu. That means any new or deleted items won't be sent to the delivery platforms automatically. This might impact order processing through the POS.

Use the Otter SSMM to manage your Menu

Self-Serve Menu Management (SSMM) is an Otter feature that allows you to create, edit, update, manage, and publish menus from Otter’s Business Manager tool.

You can find here all the helpful guides about the tool and its features.

NOTE: Any changes made to the menu manually must be replicated in both Otter and Revel POS as the integration works with menu synchronization.

 


 

Order Management

For these next steps, please, contact your Onboarding Specialist or the Otter Support team to enable the Order Injection.

What is required for the Order injection to work perfectly?

The order will be injected into your Revel POS only if the menu is synced, meaning that all menu items you have listed on Otter must be the same menu items you have listed on your Revel POS.

Please, follow these guides to ensure your menus are Synced with Revel POS:

  1. Enable Menu Auto-Sync
  2. Trigger a Manual Menu Sync in update from POS

 


 

Integration FAQs

  1. Why is my menu updating without any action from me?
  2. Why is my item in Revel POS not importing to Otter?
  3. How will my Item Variations look on the delivery platforms?
  4. What if I have different prices online and in-store?
  5. How to check if my Otter Menu is correctly Synced and linked to my Revel POS Menu?
  6. How can I reach out to Revel support if I have an issue?
  7. How to fix printing issues?
  8. What happens if an order is not injected?
  9. If orders are auto-accepted in Otter, does the order need to be acknowledged in the POS?
  10. What if an order is canceled by the customer?
  11. How do scheduled orders work?
  12. Will it show which delivery partner the order is from?
  13. If Otter loses connection to my point of sale, will my delivery accounts be taken offline?
  14. How are tips accounted for?
  15. How is sales tax accounted for?

Why is my menu updating without any action from me?

Expand for further information


 

The menu updates automatically due to our new feature, Automated Point-Of-Sale (POS) Menu Synchronization, also known as 'Menu Auto-sync', which should be activated on your account.

This feature is designed to ensure that your menu remains updated without requiring manual intervention. It synchronizes your menu every 6 hours, ensuring that any changes made are promptly reflected in Otter and from Otter to your delivery apps.

Please, check this article for future information.

Why is my item in Revel POS not importing to Otter?

Expand for further information


 

Review the following troubleshooting questions:

  • Is my Revel POS connection working? If it’s not, please make sure to have a stable internet connection and try again.
  • Is my item assigned to the Otter Menu in Revel? If it’s not, please make sure that every item you need is assigned to the Otter Menu category in the Products tab, so Otter integration can read them.

What if I have different prices online and in-store?

Expand for further information


 

Keywords: Price management, prices overrides, auto-sync prices

Currently, if you have different pricing for in-store vs delivery platforms, there are 2 options:

  • Option 1: Creating new items with uplifted price for delivery/integration use only
    This option here will provide better long-term integration success, as it provides specific parameters for troubleshooting post-live when needed.

     
  • Option 2: Utilizing Otter’s POS Self-serve Menu Management Tool to update them

This is the recommended route if you do not want to duplicate your items within Revel POS. If you would like to utilize this tool, please notify your onboarding specialist.

How to check if my Otter Menu is correctly Synced and linked to my Revel POS Menu?

Expand for further information


 

Follow the next steps if you are already up and running with your Revel POS integration, if you’re new to POS integration, you can also contact Otter Support to set you up.

Step Process Additional Information
1 Select your Menu in the App list, then enter in your menu. Step 1 How to check if my Otter Menu is correctly Synced and linked to my Revel POS Menu?.png
2 Click on Manage POS Links. Step 2 How to check if my Otter Menu is correctly Synced and linked to my Revel POS Menu?.png
3

In “Manage POS Links”, review the “Links summary” section at the top.

If all 3 boxes indicate that there are 0 unlinked items, 0 unlinked modifier groups, and 0 unlinked modifiers, it means the Otter menu is correctly Synced with Revel POS.

Step 3 How to check if my Otter Menu is correctly Synced and linked to my Revel POS Menu?.png
4

If any of the boxes indicates a number of unlinked items or modifier groups or modifiers, it means the Otter menu is not correctly synced with Revel POS.

Unlinked items can result in order injection failures and missed orders.

Step 4 How to check if my Otter Menu is correctly Synced and linked to my Revel POS Menu?.png

How can I reach out to Revel support if I have an issue?

Expand for further information


 

You can reach out to the Revel Support Center if you have other questions regarding the POS system. 

How to fix printing issues?

Expand for further information


 

For printers configured by Otter the appropriate troubleshooting steps will vary depending on whether your printer is Cloud-enabled, Bluetooth-enabled, or Hardwired. Find your type of printer below, and follow the directions listed.

For additional help or information, you can contact Otter Support.

If you are printing directly from your Revel POS system, please follow these steps:

  1. Ensure you have a stable internet connection to your Revel tablet.
  2. Make sure that there isn't a large order backlog, as this can cause delays.
  3. You can check this guide for more details or contact Revel Support.

What happens if an order is not injected?

Expand for further information


 

If there is ever an issue with an order and the order cannot be injected into Revel, then that issue will surface in the Otter tablet and appear as a POS Error.

This should not be expected often, but if it occurs then the order can be manually entered into Revel.

POS Error

If orders are auto-accepted in Otter, does the order need to be acknowledged in the POS?

Expand for further information


 

If orders are on auto-accept then the order will be imported into the POS at the time of acceptance and the order will automatically print at the appropriate time without any action from the store. To appear in the reporting, the ticket needs to be assigned a payment type and closed out.

What if an order is canceled by the customer?

Expand for further information


 

Order cancellations are not reflected through the integration. If an order is canceled, the cancellation will surface in the Otter tablet, after which the order should be manually canceled in Revel.

To enable accurate reporting, canceled orders should be actioned upon within the point of sale.

How do scheduled orders work?

Expand for further information


 

Orders will automatically be imported into Revel from Otter 30 minutes before the order is scheduled to be picked up. These orders will surface in the Otter tablet 60 minutes before ready time. 

Will it show which delivery partner the order is from?

Expand for further information


 

Yes, the delivery partner name and delivery partner order ID will be included in the order details once injected into Revel.

If Otter loses connection to my point of sale, will my delivery accounts be taken offline?

Expand for further information


 

No, your orders will continue to be executed within the delivery partners and within Otter. However, if the integration is offline for any reason, you should manually enter the orders into Revel.

How are tips accounted for?

Expand for further information


 

Tips collected in the delivery partner platforms will be routed directly to the third-party courier and will not surface in your Revel POS.

Otter integration can only send tips to Revel POS if the restaurant is using its own couriers (restaurant delivery) or when it is a pick-up order type.

How is sales tax accounted for?

Expand for further information


 

Sales tax is computed within Revel based on the tax rules that have previously been set up in Revel.

 


 

Still need help? Reach out to our team:

Chat Icon in Otter Dashboard Live Chat   Text bubble Text/SMS Message
Chat with support by clicking the chat icon in the bottom right corner of the Otter Dashboard.  

+1 (888) 681-8837

Send us a text to the number above for assistance over text message.


Updated

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request