Orders API - Menu Management

This page explains how the menu work and the associated API actions.

Contents

What is the menu?

The menu is the set of products that guests can see and order in our platform.

menu mobile-20240821-132025.gif
Guest navigating through the BK menu and adding a meal to cart

How is the menu configured?

In summary,

  • Operators/franchisees create their menu in Sanity, our CMS. They create each product and add several information such as pictures, descriptions and a PLU for in-restaurant and delivery. This is menu content management.

  • The POS also has a menu, with a PLU for each product. The POS provides pricing and availability for each restaurant to our platform, so that when guests select a store we display the right products with the right price. This is pricing and availability management.

Let’s look at the details.

Operators and franchisees configure their menu in our Content Management System, called Sanity. All items, combos, offers and rewards sold in our platform are created and configured in Sanity.

In Sanity our franchisees will add a name, description, pictures, customization options and other information to each product. Most importantly, in Sanity they will also associate a specific Price Look-up Code, or PLU, to each product for both in-restaurant and delivery for each POS used in the market.

In-restaurant PLU in Sanity

image-20241013-160614.png

Delivery PLU in Sanity

The PLU links the menu created by franchisees in Sanity with the products in the POS. That is needed because we need to display the correct price and availability for the restaurant that guests select.

API Actions

After guests have selected a store for in-restaurant orders or inputted a delivery address, they will navigate through the menu.

Update Store Menu

To ensure guests are seeing the correct pricing and availability, the POS must send us the PLU-price key/value pair, indicating whether PLU is available or not for the specific store and service mode (delivery or pickup).

 

Â