| Table of Contents | ||
|---|---|---|
|
Overview
Configure a restaurant is the first step to allow customer interact with products and perform actions such as searching a restaurant nearby, adding products to their cart and place orders.
Sanity has all restaurant info displayed in our App/Web under Order Level Content > Restaurants > Restaurant.
...
The restaurant doc is mostly populated with information from the Master Data Management (MDM) system via a sync process that runs every 15min.
...
Restaurant Documents in Sanity
Each restaurant has its own restaurant document in Sanity under Order Level Content > Restaurants > Restaurant.
...
Restaurant documents contain several information about the store. Some of the fields can be edited directly in Sanity while other fields' values are retrieved from MDM. Fields retrieved from MDM are not editable in Sanity.
| Info |
|---|
You can learn more about MDM here. You can learn more about our 4 environments (dev, staging, QA and production) here. |
This is done because MDM already has a lot of restaurant information needed by our website and app. For example, MDM has information about the restaurant’s address and opening hours which are displayed in our platform.
| Info |
|---|
The MDM restaurant sync runs every 15 minutes in our production environment. This ensures that changes to the sync’d MDM fields are reflected in website and apps in no more than 15 min. |
Below you can find a table with all fields available in the Sanity restaurant document. The two columns on the right indicate whether the field is sync’d from MDM and
Field | Explanation | MDM Sync in prod | Required for ordering | ||
|---|---|---|---|---|---|
Environment | This field can take 2 values: | Yes | Yes | ||
Mobile Ordering Status | This field can take 2 values: | Yes | Yes | ||
Has Mobile Ordering | Determines whether any type of mobile ordering is available for the restaurant. | Yes | Yes | ||
Has Delivery | Determines whether the delivery service mode is available. | Yes | Yes, for delivery | ||
Has Dine In | Determines whether the dine in service mode is available. | Yes | Yes, for dine in | ||
Has Take Out | Determines whether the take away service mode is available. | Yes | Yes, for take out | ||
Has Drive Thru | Determines whether the drive through service mode is available. | Yes | Yes, for drive thru | ||
Has Curbside | Determines whether the curbside service mode is available. | Yes | Yes, for curbside | ||
Has Catering | Determines whether the catering service mode is available. | Yes | Yes, for catering | ||
Has Table Service | Determines whether the table service mode is available. | Yes | Yes, for catering | ||
Late Night Pricing | Enable Late Night pricing on Digital Operations Portal. You can learn more about the Digital Operations Portal here. | No | No | ||
Number | Unique restaurant number, use as the restaurant identifier. In the case of Burger King, this number is known as “BK number". | Yes | Yes | ||
Name | Restaurant name using by Sanity to identify | Yes | Yes | ||
Physical Address | Contains the following fields:
 
| Yes | Yes | ||
Restaurant Phone Number |  Phone number displayed in the restaurant information modal, which appears upon clicking on | Yes | No | ||
VAT Number | Restaurant’s VAT number | Yes | No | ||
Latitude and Longitude | Restaurant’s coordinates. These are used to calculate the distance to the guest’s inputted address. | Yes | Yes | ||
Day parts | Yes | No | |||
Status | Indicates whether the restaurant is | Yes | Yes, must be | ||
Drive Thru Lane Type | Type of drive through lane. | Yes | No | ||
Has Playground | Indicates whether the store has a playground for kids. | Yes | No | ||
Drink Station Type | Type of drink station. | Yes | No | ||
Has Parking | Indicates whether the restaurant has parking. That information can be displayed to guests as an amenity in the restaurant information modal. You can learn more about configuring amenities here. | Yes | No | ||
Has Wifi | Indicates whether the restaurant has wifi. That information can be displayed to guests as an amenity in the restaurant information modal. You can learn more about configuring amenities here. | Yes | No | ||
Has Breakfast | Indicates whether the store has parking. That information can be displayed to guests as an amenity in the restaurant information modal. You can learn more about configuring amenities here. | Yes | No | ||
Has Internal Delivery Fleet | Indicates if the restaurant fulfills delivery orders using Bringg as the delivery fulfillment provider. If you don’t know what Bringg is, this field should be set to false. | Yes | Yes, if restaurant uses Bringg | ||
Has Burgers for Breakfast | Indicates whether the store offers burgers for breakfast. | Yes | No | ||
Has Loyalty | Indicates whether the restaurant offers loyalty. You can learn more about how this field is used here. | Yes | No | ||
Front Counter Closed | Indicates whether the restaurant’s front counter is closed. | Yes | No | ||
Has DMB suggestive selling | Indicates whether digital menu boards offer suggestive selling. | Yes | No | ||
Number of Drive Thru Windows | Indicates the number of drive through windows available in the restaurant. | Yes | No | ||
Is Halal |  Indicates whether the restaurant is Halal. If enabled, the store locator disabled a Halal icon. | Yes | No | ||
POS Vendor | Indicates what POS is used. This field determines what POS integrations and set of PLUs to use for each restaurant.
If your POS integration uses our Partner API, set this field to | Yes | Yes | ||
POS Version | Version of the POS. | Yes | No | ||
Ownership | Indicates the ownership of the restaurant. | Yes | No | ||
Franchise Group Name | Indicates the name of the Franchise Group that the restaurant belongs to. | Yes | No | ||
Franchise Group ID | Franchise Group ID that the restaurant belongs to. | Yes | No | ||
Email used for catering service mode | Yes | No | |||
Internal Name | MDM’s internal restaurant name. | ||||
Amenities | List of amenities available at the restaurant, displayed in the restaurant information modal, which appears upon clicking on | Yes | No | ||
Delivery Providers | Yes | No | |||
Hide Click & Collect Ordering | Hides the | No | No | ||
Display Offers button in Store Selector | Hides the | No | No | ||
Restaurant image | Determines the image shown on the top of the restaurant information modal, which appears upon clicking on | No | No | ||
ADI | Yes | No | |||
Parking Type | Type of parking in the restaurant. | Yes | No | ||
Hours of Operation | |||||
Timezone | Determines the restaurant timezone. It’s required to interpret the hours of operation correctly. | Yes | Yes | ||
POS Restaurant ID | Used for restaurant that use the NCR ATO integration. It’s the BSP ID which identified the restaurant. | Yes, if store uses NCR ATO as POS | |||
Landmark | Yes | No | |||
Customer Facing Address | This field overwrites the restaurant name displayed in the store locator. If left empty, the value under Physical Address > Address 1 will be used as the restaurant name. | No | No | ||
Hide in Environments | Allows to hide the restaurant in either the | No | No | ||
Delivery Configuration | Store delivery provider’s store IDs. Only used for Smood. | Yes | Yes, if you use Smood as a delivery provider | ||
Wait Time Parameters | No | No | |||
Integration | If your POS integration goes through our Partner API, this field must be set to the corresponding Partner Group. Partner Groups represent a group of one or more integrations, usually a POS integration and a delivery integration (e.g. Oracle and Grubtech). By adding the Partner Group to the restaurant document, the store is automatically assigned to the integration and the vendors can access it. | No | Yes, if your POS is integrated via Partner API |
Adding a new restaurant
The process to add a new restaurant starts in RBI’s Master Data Management (MDM) system with all the store information. You should . Restaurant prospects are added to the platform with status Projected, and once the opening is approved they transition to Open.
| Info |
|---|
Please contact your Area Franchisee Leads (AFL) to create and |
...
open new restaurants in MDM. |
...
Once a restaurant is created in MDM, a corresponding restaurant document will be automatically created in Sanity under Order-Level Content > → Restaurants > Restaurant.
...
All Most restaurant information from restaurants such as geolocation status, coordinates, address, available service available, modes and restaurant amenities should be input in come from RBI’s Master Data Management (MDM) . That info will sync with Sanity (CMS), which feeds our platform.
Operation teams use Restaurant Attribute Management (RAM) portal to manage the main info from restaurants once Franchisees don’t have access on RBI’s Master Data Management (MDM).
Once the restaurant is opened, AFLs update status to ‘Open’ in MDM, which updates in Sanity. At this point the restaurant shows to guests.
Updating restaurant information
We have available 3 procedures to update restaurant information as following:
...
system.
...
As explained in the previous section, the applicable restaurant values in MDM will be automatically updated in Sanity every 15min.
| Info |
|---|
Restaurants can have the following statuses in MDM: |
Updating restaurant information
As explained above, some of the restaurant information will be synced from MDM, while other information can be added directly in Sanity.
Editing information sync’d from MDM
There’s two ways to edit information sync’d from MDM:
Restaurant Attribute Management (RAM) Portal (https://ram.rbi.com/;
Sanity (CMS).
...
). RAM is the portal available for franchisees to update restaurant information
...
Updating restaurant amenities images and names
Amenities are available services in each restaurant. You are able to set up a display of available amenities in each restaurant, which will show in the information modal of the restaurant:
For example:
Restaurant accepts credit card
Restaurant has baby changer
Restaurant has Wi-Fi
(…)
...
Restaurant Amenities cannot be created in Sanity, as they will be automatically synchronised from MDM.
You need to send a request to GBS team via email gbsrequest@rbi.com in order to update the Restaurant Amenities.
...
stored in MDM. The following information can be updated: address, phone, available service modes, mobile ordering status, amenities and hours of operation.
...
| Info |
|---|
Your restaurant operations teams can grant you access to the RAM portal. |
GBS Request. You can send a request to GBS team via email gbsrequest@rbi.com, who will update team responsible for any restaurant update. To expedite the changes, please use the templates below:
| Expand | ||||
|---|---|---|---|---|
| ||||
|
| Expand | ||||
|---|---|---|---|---|
| ||||
|
Editing information not sync’d from MDM
Information not sync’d from MDM can normally be directly edited in the Sanity restaurant document. That includes all the fields in the table presented here where the ‘MDM Sync in prod columns’ equals No.
| Info |
|---|
If you need to edit a non-MDM field in Sanity which is not editable (grayed out), please reach out to your CSM. |
Updating restaurant amenities images and names
Restaurant amenities are displayed in the restaurant information modal. This includes amenities like:
...
Has Wifi
Has Delivery
Accepts Cards
Payback
Baby Changer
Accessible
Kind Deals
Digital Coupons
King of the month
Freestyle Coke Machine
Playground
Paper Coupons
Has Breakfast
Restaurant Amenities values are retrievedfrom MDM and populated in the restaurant document, as they will be automatically synchronized from MDM.
...
In Sanity, under Order Level Content > Restaurants > Restaurant Amenities, you can change configure the icon and translations text shown to guests in the restaurant info modal for each of the amenities in the restaurant document.
...
...
Restaurant fields required for
...
online ordering
...
| Info |
|---|
This section describes the |
...
In Sanity, under Order Level Content > Restaurants > Restaurant, you can review the fields required which will be automatically synchronised from MDM.
required restaurant configuration needed to enable ordering. As described here, ordering also requires a POS integration, a configured menu, a payment service provider and a delivery service provider. |
The restaurant fields required for online ordering are described in the table in this section – the column ‘Required for ordering’ indicates whether each field is needed to enable ordering.
Note that different each available service mode (delivery, table service, curbside, etc) has its own field to enable it.
| Expand | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|
| Info |
|---|
You can learn more about the different service modes here. |