Help Center
How can we help? 👋

How to set up Revel integration

Step 1 - Get API information

The Atlas team will use this information to set up the integration with Revel. These are the details we will need:

  • Establishment Number(s) (if you have multiple locations, each location will have a unique number)
  • API key and API secret:
    • If you don’t have this information, you can email to your Revel reseller something similar to this:

      Hi...,
      We will integrate Revel with Atlas, and we need our API KEY, API SECRET, Revel Account url and Establishment Number.
      Can you be able to provide me with that information?
      Cheers,

      ^ It might take a couple of days for them to share the above information. Share it with your Atlas account manager once you receive it, and we will handle the rest.

       

Step 2 - Configuration on Revel

2.1 - Set up menus

Revels allow merchants to create custom menus that can be used for online orders (aka web orders). Atlas will pull these menus to use them for your delivery and dine-in channels.

Here’s a quick view on how the mapping works:

 
Delivery menu set up on Revel.
Delivery menu set up on Revel.
Same delivery menu on Atlas, when it’s pulled from Revel.
Same delivery menu on Atlas, when it’s pulled from Revel.

For menus — if your dine-in and delivery menus are different (e.g. pricing, product names, SKUs), you will need to set up on Revel a menu for each of these channels, and check the Categories Atlas should pull.

Notion image

For products — you will need to set each price variation as a different Product on Revel, and house it under the correct Sub-category > Category.

Your custom menus should have these values:

  • Name: Enter something to easily identify the menu (e.g. Atlas Scan To Order).
  • Application Type: Mode
  • Mode / Station: Online
  • Active: Check
Notion image
  • Click on Effective Dates/Time > Toggle Date Range & Everyday as Open > Set Date Range Start Date as a day in the past, leave End Date empty > Ensure Everyday is Open at 12:00AM & Close at 11:59PM > Save
Notion image
 
ℹ️
You will need to set 2 sets of SKUs on Revel, if you are using Atlas Aggregator and your third-platform menus (e.g. Grabfood, Deliveroo) have a different price.

2.2 - Set up dining options

To set up the integration, we need to link Atlas order sources (e.g. Scan to order, Grabfood, etc.) to a corresponding Dining option(s) on Revel. More than one order source can point to the same Dining option too.

Create a dining option on Revel, and share with your Account Manager the mapping Atlas should follow. You can check Revel’s guide on how to set up a custom dining option.

2.3 - Set up payment types

To set up the integration, we need to link Atlas order sources (e.g. Scan to order, Grabfood, etc.) to a corresponding Payment types option(s) on Revel. More than one order source can point to the same Dining option too.

Usually, most merchants just point all Atlas orders to a single Payment option on Revel, called “Atlas”.

Create a payment type on Revel, and share with your Account Manager the mapping Atlas should follow. You can check Revel’s guide on how to create a custom payment option.

2.4 - Set up discounts

Set up a dynamic discount on Atlas and share the barcode with Atlas. Revel only supports dynamic discounts with online orders, so we will need to set that up.

Notion image
 

2.5 - Set up dynamic service fee (for delivery fees)

We will need to set up a dynamic service fee to capture the delivery fee on Revel too. When you create this, make sure the Alias is deliveryfee, all in small characters and single word.

Here an example of how your Dynamic delivery fee should look like:

Notion image
 
ℹ️
If you don’t see this option, reach out to your Revel reseller so that they enable it for you. Dynamic service can only enabled by the Revel support team.

2.6 - Enable the “Print online orders” option on the main POS station

This option can only be enabled on one POS station per outlet. Usually, Revel recommends enabling this option at the central station at the outlet. To enable Print Online orders:

  • Go to Establishment > Stations > Select your main or central station > Scroll down to Printing on the Details tab > Check the box Print Online Orders
    • Notion image

If you don’t see this option, reach out to your Revel reseller so that they enable it for you. Print Online orders can only enabled by the Revel support team. You might still not be able to see it, even after they enabled it for you.

ℹ️
After Atlas syncs your orders to Revel, any printing configuration within Revel needs to be configured directly on Revel (and cannot be set on Atlas).

Step 3 - Configuration on Atlas

3.1 - Set up Revel sync lead time and Atlas print lead time

When a new order flows in, we can help you set two types of triggers:

  • Atlas print lead time → When you want orders to print on your Atlas hardware
  • Revel sync lead time → When you want orders to sync to Revel POS. This is a lead time is counted from the serving time (and not preparation time).

*Example:

  • Atlas print lead time = 120 mins
  • Revel sync lead time = 30 mins

If a delivery order is placed at 10am, for the serving time of 4:00pm - 4:30pm, this will happen:

  • Order prints on your Atlas at 2:00pm.
  • Order syncs to Revel (and print on your Revel printers) at 3:30pm.
 

*Best practice: Print orders earlier on Atlas hardware (so that front of house is aware and can plan), and sync them to Revel only when the kitchen should start preparing them.

3.2- Set up table mapping between Atlas & Revel

If your Revel establishment is using tables and you need that information for operations, we will need to:

  1. Set up tables on Revel
  1. Set up tables on Atlas
  1. (Atlas team) Do a manual mapping for these 2 tables
  1. (Atlas team) Enable feature flip use_revel_table_integration to send table information with each order

Reach out to your main point of contact on Atlas to get points 3 & 4 done, and if you need any help with point 2.

Step 4 - Test the integration

4.1 - Schedule testing time with the merchant to test the integration

  1. Verify menu sync (products, prices) on Atlas
  1. Verify order sync on Revel
    1. The order appears on POS stating as a closed order
    2. The order appears with the correct dining option
    3. The order appears with the correct payment option
    4. The order appears with the correct payment breakdown
    5. The order appears with the correct call name
    6. The order appears on the order history report
    7. (if using tables) The order appears with the correct table

FAQs & other info

Important considerations

  • If this is not a brand-new integration, some of your existing Online pre-orders placed before the integration is set up will not sync to Revel.
  • Atlas does not currently support Revel Combos / Product Group pricing. Aggregator stores (e.g. Grabfood, Foodpanda) usually have issues with this setup too.

Settings FAQs

What details do we need from the merchant to enable Revel?
  • API key
  • API secret
  • Account URL
  • Establishment ID
What permissions do they need on the Revel account to pull the menu?
  • Permission to pull the web orders menu for a given establishment
  • Permission to push the a web orders
  • Permission to pull dining options
  • Permission to pull payment options
What settings are required to be configured for Atlas to push orders to Revel?
  • Revel needs to turn on Print online orders option in order to listen to web orders
    • Notion image
       
What payment methods does Atlas use?
  • Atlas uses one of the payment methods listed on /resources/CustomPaymentType API (verify this with merchant)
 

Menu FAQs

What menu does Atlas pull from Revel?
  • Atlas uses web orders menu weborders/menu/?establishment=${establishment}
Where to verify the online menus on Revel?
  • All the custom menus that are tagged as Online will be part of this menu
    • Notion image
  • All the categories/products that are marked to be in an online menu will be part of the menu
    • Notion image