> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # BulkUpdateMenuOrderingSettings # Package: onlineOrders # Namespace: MenuOrderingSettingsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/online-orders/menu-ordering-settings/bulk-update-menu-ordering-settings.md ## Permission Scopes: Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES ## Introduction 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. --- ## REST API ### Schema ``` Method: bulkUpdateMenuOrderingSettings Description: 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. URL: https://www.wixapis.com/v1/bulk/menu-ordering-settings/update Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: menusOrderingSettings, menusOrderingSettings.menuOrderingSettings.id, menusOrderingSettings.menuOrderingSettings.revision Method parameters: param name: menusOrderingSettings | type: array | description: Menu ordering settings entities to update. | required: true - name: menuOrderingSettings | type: MenuOrderingSettings | description: Menu ordering settings entities to update. - name: id | type: string | description: Menu ordering settings object GUID. | required: true - name: revision | type: string | description: Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be specified when updating a menu ordering settings object. | required: true - name: operationId | type: string | description: GUID of the restaurant operation the menu belongs to. (See the Restaurants Operations API for more information.) - name: onlineOrderingEnabled | type: boolean | description: Whether online ordering is enabled for the menu. - name: availability | type: Availability | description: Menu availability settings. - ONE-OF: - name: weeklyScheduleOptions | type: WeeklyScheduleOptions | description: Settings for availability on a weekly schedule. - name: availableTimes | type: array | description: List of available time ranges for specific days of the week. - name: dayOfWeek | type: DayOfWeek | description: The day of week this availability relates to. - enum: - MON: Monday. - TUE: Tuesday. - WED: Wednesday. - THU: Thursday. - FRI: Friday. - SAT: Saturday. - SUN: Sunday. - name: timeRanges | type: array | description: A list of time ranges during which the fulfillment should be available. - name: startTime | type: TimeOfDay | description: The start time in time of day representation. - name: hours | type: integer | description: Hours.
Min: `0`.
Max: `23`. - name: minutes | type: integer | description: Minutes.
Min: `0`.
Max: `23`. - name: endTime | type: TimeOfDay | description: The end time in time of day representation. - name: timestampRangesOptions | type: TimestampRangesOptions | description: Settings for availability within a time range. - name: ranges | type: array | description: List of available time ranges. - name: startTime | type: string | description: The start time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: endTime | type: string | description: The end time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: type | type: AvailabilityType | description: Availability type. - enum: - UNSPECIFIED_AVAILABILITY_OPTION: Missing type due to an error. - ALWAYS_AVAILABLE: Available all the time. - WEEKLY_SCHEDULE: Available on specific days and times throughout the week. - TIMESTAMP_RANGES: Available during a specific time range. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)) used to classify and sort different types of menu ordering settings. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: mask | type: | description: Explicit list of fields to update. param name: returnEntity | type: returnEntity | description: Whether to receive the entity in the response. Return type: BulkUpdateMenuOrderingSettingsResponse - name: results | type: array | description: Results of bulk menu ordering settings entities update. - name: menuOrderingSettingsMetadata | type: ItemMetadata | description: Metadata for menu update. - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: menuOrderingSettings | type: MenuOrderingSettings | description: Updated menu ordering settings. Only returned if `returnEntity` is set to `true`. - name: id | type: string | description: Menu ordering settings object GUID. - name: revision | type: string | description: Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be specified when updating a menu ordering settings object. - name: createdDate | type: string | description: Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: updatedDate | type: string | description: Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: operationId | type: string | description: GUID of the restaurant operation the menu belongs to. (See the Restaurants Operations API for more information.) - name: menuId | type: string | description: GUID of the menu these settings apply to. - name: onlineOrderingEnabled | type: boolean | description: Whether online ordering is enabled for the menu. - name: availability | type: Availability | description: Menu availability settings. - ONE-OF: - name: weeklyScheduleOptions | type: WeeklyScheduleOptions | description: Settings for availability on a weekly schedule. - name: availableTimes | type: array | description: List of available time ranges for specific days of the week. - name: dayOfWeek | type: DayOfWeek | description: The day of week this availability relates to. - enum: - MON: Monday. - TUE: Tuesday. - WED: Wednesday. - THU: Thursday. - FRI: Friday. - SAT: Saturday. - SUN: Sunday. - name: timeRanges | type: array | description: A list of time ranges during which the fulfillment should be available. - name: startTime | type: TimeOfDay | description: The start time in time of day representation. - name: hours | type: integer | description: Hours.
Min: `0`.
Max: `23`. - name: minutes | type: integer | description: Minutes.
Min: `0`.
Max: `23`. - name: endTime | type: TimeOfDay | description: The end time in time of day representation. - name: timestampRangesOptions | type: TimestampRangesOptions | description: Settings for availability within a time range. - name: ranges | type: array | description: List of available time ranges. - name: startTime | type: string | description: The start time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: endTime | type: string | description: The end time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: type | type: AvailabilityType | description: Availability type. - enum: - UNSPECIFIED_AVAILABILITY_OPTION: Missing type due to an error. - ALWAYS_AVAILABLE: Available all the time. - WEEKLY_SCHEDULE: Available on specific days and times throughout the week. - TIMESTAMP_RANGES: Available during a specific time range. - name: timeZone | type: string | description: Time zone in [Time Zone Database](https://www.iana.org/time-zones) format. - name: businessLocationId | type: string | description: Business location GUID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations.md)) of the menu. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)) used to classify and sort different types of menu ordering settings. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: bulkActionMetadata | type: BulkActionMetadata | description: Metadata for the API call. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Bulk update menu ordering settings ```curl curl -X PATCH https://www.wixapis.com/menu-ordering-settings/v1/bulk/menu-ordering-settings/update \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: ' \ --data-raw '{ "return_full_entity": true, "menuOrderingSettings":[ { "menuOrderingSettings": { "id": "f83c385c-1485-4daa-9bba-bc332e12c8ce", "revision": "3", "operationId": "48605ac5-53fc-49b4-96b2-87f7636f5ce0", "menuId": "bbb65621-6338-4837-8fdd-aebc654523e0", }, "mask": { "paths": [ "operationId", "menuId", ] } } ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.onlineOrders.MenuOrderingSettingsService.bulkUpdateMenuOrderingSettings(menusOrderingSettings, options) Description: 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: menusOrderingSettings, menusOrderingSettings.menuOrderingSettings._id, menusOrderingSettings.menuOrderingSettings.revision Method parameters: param name: menusOrderingSettings | type: array | description: Menu ordering settings entities to update. | required: true - name: menuOrderingSettings | type: MenuOrderingSettings | description: Menu ordering settings entities to update. - name: _id | type: string | description: Menu ordering settings object GUID. | required: true - name: revision | type: string | description: Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be specified when updating a menu ordering settings object. | required: true - name: operationId | type: string | description: GUID of the restaurant operation the menu belongs to. (See the Restaurants Operations API for more information.) - name: onlineOrderingEnabled | type: boolean | description: Whether online ordering is enabled for the menu. - name: availability | type: Availability | description: Menu availability settings. - ONE-OF: - name: weeklyScheduleOptions | type: WeeklyScheduleOptions | description: Settings for availability on a weekly schedule. - name: availableTimes | type: array | description: List of available time ranges for specific days of the week. - name: dayOfWeek | type: DayOfWeek | description: The day of week this availability relates to. - enum: - MON: Monday. - TUE: Tuesday. - WED: Wednesday. - THU: Thursday. - FRI: Friday. - SAT: Saturday. - SUN: Sunday. - name: timeRanges | type: array | description: A list of time ranges during which the fulfillment should be available. - name: startTime | type: TimeOfDay | description: The start time in time of day representation. - name: hours | type: integer | description: Hours.
Min: `0`.
Max: `23`. - name: minutes | type: integer | description: Minutes.
Min: `0`.
Max: `23`. - name: endTime | type: TimeOfDay | description: The end time in time of day representation. - name: timestampRangesOptions | type: TimestampRangesOptions | description: Settings for availability within a time range. - name: ranges | type: array | description: List of available time ranges. - name: startTime | type: Date | description: The start time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: endTime | type: Date | description: The end time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: type | type: AvailabilityType | description: Availability type. - enum: - UNSPECIFIED_AVAILABILITY_OPTION: Missing type due to an error. - ALWAYS_AVAILABLE: Available all the time. - WEEKLY_SCHEDULE: Available on specific days and times throughout the week. - TIMESTAMP_RANGES: Available during a specific time range. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)) used to classify and sort different types of menu ordering settings. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: mask | type: array | description: Explicit list of fields to update. param name: options | type: BulkUpdateMenuOrderingSettingsOptions none - name: returnEntity | type: boolean | description: Whether to receive the entity in the response. Return type: PROMISE - name: results | type: array | description: Results of bulk menu ordering settings entities update. - name: menuOrderingSettingsMetadata | type: ItemMetadata | description: Metadata for menu update. - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: menuOrderingSettings | type: MenuOrderingSettings | description: Updated menu ordering settings. Only returned if `returnEntity` is set to `true`. - name: _id | type: string | description: Menu ordering settings object GUID. - name: revision | type: string | description: Revision number. Increments by 1 each time the menu ordering settings object is updated. To prevent conflicting changes, the existing revision must be specified when updating a menu ordering settings object. - name: _createdDate | type: Date | description: Date and time the menu ordering settings object was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: _updatedDate | type: Date | description: Date and time the menu ordering settings object was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: operationId | type: string | description: GUID of the restaurant operation the menu belongs to. (See the Restaurants Operations API for more information.) - name: menuId | type: string | description: GUID of the menu these settings apply to. - name: onlineOrderingEnabled | type: boolean | description: Whether online ordering is enabled for the menu. - name: availability | type: Availability | description: Menu availability settings. - ONE-OF: - name: weeklyScheduleOptions | type: WeeklyScheduleOptions | description: Settings for availability on a weekly schedule. - name: availableTimes | type: array | description: List of available time ranges for specific days of the week. - name: dayOfWeek | type: DayOfWeek | description: The day of week this availability relates to. - enum: - MON: Monday. - TUE: Tuesday. - WED: Wednesday. - THU: Thursday. - FRI: Friday. - SAT: Saturday. - SUN: Sunday. - name: timeRanges | type: array | description: A list of time ranges during which the fulfillment should be available. - name: startTime | type: TimeOfDay | description: The start time in time of day representation. - name: hours | type: integer | description: Hours.
Min: `0`.
Max: `23`. - name: minutes | type: integer | description: Minutes.
Min: `0`.
Max: `23`. - name: endTime | type: TimeOfDay | description: The end time in time of day representation. - name: timestampRangesOptions | type: TimestampRangesOptions | description: Settings for availability within a time range. - name: ranges | type: array | description: List of available time ranges. - name: startTime | type: Date | description: The start time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: endTime | type: Date | description: The end time of the availability in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. - name: type | type: AvailabilityType | description: Availability type. - enum: - UNSPECIFIED_AVAILABILITY_OPTION: Missing type due to an error. - ALWAYS_AVAILABLE: Available all the time. - WEEKLY_SCHEDULE: Available on specific days and times throughout the week. - TIMESTAMP_RANGES: Available during a specific time range. - name: timeZone | type: string | description: Time zone in [Time Zone Database](https://www.iana.org/time-zones) format. - name: businessLocationId | type: string | description: Business location GUID ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations.md)) of the menu. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags ([SDK](https://dev.wix.com/docs/sdk/backend-modules/tags/tags/introduction.md) | [REST](https://dev.wix.com/docs/rest/business-management/tags/introduction.md)) used to classify and sort different types of menu ordering settings. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: bulkActionMetadata | type: BulkActionMetadata | description: Metadata for the API call. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### bulkUpdateMenuOrderingSettings ```javascript import { menuOrderingSettings } from '@wix/restaurants'; async function bulkUpdateMenuOrderingSettings(menusOrderingSettings,options) { const response = await menuOrderingSettings.bulkUpdateMenuOrderingSettings(menusOrderingSettings,options); }; ``` ### bulkUpdateMenuOrderingSettings (with elevated permissions) ```javascript import { menuOrderingSettings } from '@wix/restaurants'; import { auth } from '@wix/essentials'; async function myBulkUpdateMenuOrderingSettingsMethod(menusOrderingSettings,options) { const elevatedBulkUpdateMenuOrderingSettings = auth.elevate(menuOrderingSettings.bulkUpdateMenuOrderingSettings); const response = await elevatedBulkUpdateMenuOrderingSettings(menusOrderingSettings,options); } ``` ### bulkUpdateMenuOrderingSettings (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { menuOrderingSettings } from '@wix/restaurants'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { menuOrderingSettings }, // Include the auth strategy and host as relevant }); async function bulkUpdateMenuOrderingSettings(menusOrderingSettings,options) { const response = await myWixClient.menuOrderingSettings.bulkUpdateMenuOrderingSettings(menusOrderingSettings,options); }; ``` ---