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.

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.

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: `dev` and `prod`. It determines whether a store will appear in the selected environment. `dev` refers to our development and staging environments, `prod` refers to our QA and production environments. E.g. a restaurant marked as `dev` will not appear in our production environment.	Yes	Yes
Mobile Ordering Status	This field can take 2 values: `dev` and `live`. It determines whether ordering is available in the selected environment. `dev` mean ordering is only available in our development and staging environments. `live` means ordering is only available in our QA and production environments.	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: Address 1: this is the restaurant’s main address, and it is used as the restaurant name in the store locator. This field can be overwritten using the Customer Facing Address field. Address 2: additional details about the restaurant’s address. City State/Province and State/Province abbreviation Country Postal Code	Yes	Yes
Restaurant Phone Number	Phone number displayed in the restaurant information modal, which appears upon clicking on `View store details`.	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 `Projected`, `Open`, `Temp Closed`, `Closed`. Only restaurants with only restaurants with status `Open` appear in the store locator.	Yes	Yes, must be `Open`
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.	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. You can learn more about PLUs and menu configuration here. If your POS integration uses our Partner API, set this field to `Partner`.	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	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 `View store details`. You can learn more about configuring amenities here.	Yes	No
Delivery Providers		Yes	No
Hide Click & Collect Ordering	Hides the `Select` button for the restaurant in the store locator Pick Up view. Used if restaurants offer delivery but not Pick Up.	No	No
Display Offers button in Store Selector	Hides the `Offers` button for the restaurant in the store locator.	No	No
Restaurant image	Determines the image shown on the top of the restaurant information modal, which appears upon clicking on `View store details`. If left empty, it will default to a map of the restaurant location.	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 `dev` or `prod` environments. For instance, if you want to hide an `Open` restaurant from the production website and apps.	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. Restaurant prospects are added to the platform with status Projected, and once the opening is approved they transition to Open.

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.

Most restaurant information such as status, coordinates, address, available service modes and restaurant amenities come from RBI’s Master Data Management (MDM) system.

As explained in the previous section, the applicable restaurant values in MDM will be automatically updated in Sanity every 15min.

Restaurants can have the following statuses in MDM: Projected, Open, Temp Closed, Closed, Re-opened. All restaurants will sync into Sanity, but only restaurants with status Open appear in the store locator.

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/). RAM is the portal available for franchisees to update restaurant information stored in MDM. The following information can be updated: address, phone, available service modes, mobile ordering status, amenities and hours of operation.

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:

For changes to one restaurant

Subject: "O2C-DMT - Update Restaurant Attributes (Minor Upload)"
Attachment: SIF_5.2.1 Update Restaurant attributes (Minor Upload).xlsm
Hello DMT team,
Please find the attached form to update Restaurant attributes to MDS
Thanks!

For changes to multiple restaurant

Subject: "O2C-DMT - Update Restaurant Attributes (Major Upload)"
Attachment: SIF_5.2.1 Update Restaurant attributes (Major Upload).xlsm
Hello DMT team,
Please find the attached form to update Restaurant attributes to MDS
Thanks!

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.

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 retrieved from 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 configure the icon and text shown to guests in the restaurant info modal for each of the amenities in the restaurant document.

Restaurant fields required for online ordering

This section describes the 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.

Summary

Field	Description
Number	Restaurant Number
Name	Restaurant Name
Physical Address	Address 1 City State/Province State/ Province Abbreviation Country Postal Code
Latitude/Longitude	GPS coordinates
Status	Open
POS > Vendor	Select the corresponding POS vendor: PARTNER
Mobile Ordering Status	Live
Has Mobile Ordering?	Toggle: True (LaunchDarkly flag must also be on for ordering button to be enabled)
Has Delivery?	Toggle: True (in case the restaurant serves Delivery)

You can learn more about the different service modes here.

Restaurants - Configuration Guide