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, or only on certain holidays.

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 either refers to its associated operation, or has the value "none".

If you create a menu ordering settings object manually you can specify an operationId. If you don't specify one, or the menu ordering settings object is created automatically, the operationId is assigned automatically. The value assigned is the ID of the operation in the earliest created operation group (by date) with the same businessLocationId as the menu ordering settings object's menu.

If there is no matching operation, the menu ordering settings object's operationId is set to "none".

Menu ordering settings have the businessLocationId of their menu. This is maintained automatically by the server with eventual consistency. To function correctly, a menu ordering settings object's operation must also have the same businessLocationId.

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

Before you begin

• 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. You shouldn't uninstall the Wix Restaurants Menus (New) app, as menu ordering setting won't function correctly without it.

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.