Introduction

The Menu Ordering Settings API allows you to retrieve and manage menu ordering settings for a restaurant operation.

Menu ordering settings define the availability of menus for ordering. They allow you to:

  • Define whether a menu is available for online orders. For example, a restaurant may not want to sell items from the "Alcohol" menu online.
  • Define the times that a menu is available. For example, the restaurant may want to offer a unique menu only on Tuesdays.

With the Menu Ordering Settings API, you can:

  • Manage menu ordering settings for a restaurant operation.
  • List menus' availability statuses.

Menu ordering setting objects are created automatically for each menu when the Wix Restaurants Orders (New) app is installed, or subsequently when a new menu is created. Each menu can only be associated with one restaurant operation. Each menu ordering settings object has an operationID that refers to its associated operation. By default, every menu ordering settings object is assigned the ID of the first operation created on the Wix site. This can be changed later.

Likewise, when a menu is deleted, its associated menu ordering setting object is deleted automatically.

Before you begin

It’s important to note the following points before starting to code:

  • The Wix user must install the Wix Restaurants Orders (New) app.
  • The Wix user must install the Wix Restaurants Menus (New) app. This app is installed automatically along with the Wix Restaurants Orders (New) app. However, it's possible to uninstall it separately. If this occurs, the Menu Ordering Settings API will still function, but the Menu Ordering Settings objects will no longer relate to any menus.

Terminology

  • Operation: A distinct service that a restaurant offers. For example, a restaurant may offer a takeaway operation and a catering operation, where each would work with different time frames, availabilities, and fees.
Did this help?