Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Info

This field can be overwritten using the Customer Facing Address field.

image-20240914-163203.pngimage-20240914-163224.png
  • Address 2: additional details about the restaurant’s address.

  • City

  • State/Province and State/Province abbreviation

  • Country

  • Postal Code

Yes

Yes

Restaurant Phone Number

image-20240914-163428.png

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. 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

image-20240914-182417.png

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.

Info

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

...

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.

...

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.

...