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?

Setup

@wix/restaurants

To use the MenuOrderingSettings API, install the @wix/restaurants package using npm or Yarn:

Copy
npm install @wix/restaurants

or

Copy
yarn add @wix/restaurants

Then import { menuOrderingSettings } from @wix/restaurants:

Copy
import { menuOrderingSettings } from "@wix/restaurants";
Did this help?

bulkUpdateMenuOrderingSettings( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates multiple menu ordering settings entities at once. Each time a menu ordering settings entity is updated, revision increments by 1. The existing revision must be specified when updating the menu ordering settings entity. This ensures you're working with the entity's latest information, and it prevents unintended overwrites.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function bulkUpdateMenuOrderingSettings(
  menusOrderingSettings: Array<MaskedMenuOrderingSettings>,
  options: BulkUpdateMenuOrderingSettingsOptions,
): Promise<BulkUpdateMenuOrderingSettingsResponse>;
Method Parameters
menusOrderingSettingsArray<MaskedMenuOrderingSettings>Required

Menu ordering settings entities to update.

optionsBulkUpdateMenuOrderingSettingsOptions
Returns
Return Type:Promise<BulkUpdateMenuOrderingSettingsResponse>
JavaScript
import { menuOrderingSettings } from "@wix/restaurants";

async function bulkUpdateMenuOrderingSettings(menusOrderingSettings, options) {
  const response = await menuOrderingSettings.bulkUpdateMenuOrderingSettings(
    menusOrderingSettings,
    options,
  );
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?