About Sections

The Sections API allows you to manage menu sections. Sections gather together various dishes (or items) into groups, such as "Appetizers", "Mains", "Desserts", "Drinks" and so on.

With the Section API, you can:

  • Create, delete, and update sections.
  • Retrieve the information about a section.

Before you begin

It's important to note the following point before starting to code:

  • The Sections API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Use cases

Terminology

Menu: A list of food and beverage items available for purchase at a restaurant, café, or other dining establishment.

Did this help?

Sections: Sample Use Cases & Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.

Sync pizza menus across all sites

If you have several pizzeria sites that use your app you might need to sync menu across those sites. For example, if you have a new section in the menu, called "Salads" this change also needs to be reflected on other sites.

To sync the pizza menu across all sites:

  1. Call Get Section on the site where you created a new section.
  2. Extract the whole section object.
  3. Call Create Section for your other sites and pass the new section to each.
  4. Call Update Menu and add the new section ID to the sectionIds array.
Did this help?

Section: Supported Filters and Sorting

The following table shows field support for filters and sorting for the section object:

FieldSupported FiltersSortable
id$eq, $ne, $in, $ninSortable
createdDate$eq, $ne, $gt, $lt, $gte, $lteSortable
updatedDate$eq, $ne, $gt, $lt, $gte, $lteSortable
name$eq, $ne, $in, $nin, $beginsSortable
description$eq, $ne, $in, $nin, $beginsSortable
image$existsSortable
itemIds$exists, $hasSomeSortable

Related content: API Query Language, Query Sections.

Did this help?

Section Object


Properties
idstringRead-onlyformat GUID

Section ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the section is updated. To prevent conflicting changes, the current revision must be passed when updating the section. Ignored when creating a section.


createdDatestringRead-onlyformat date-time

Date and time the section was created.


updatedDatestringRead-onlyformat date-time

Date and time the section was updated.


namestringminLength 1maxLength 500

Section name.


descriptionstringmaxLength 1500

Section description.


imageImage

Main section image.


additionalImagesArray <Image>maxItems 100

Additional section images.


itemIdsArray <string>format GUIDmaxItems 1000

Item IDs.


extendedFieldsExtendedFields

Extended fields.


visibleboolean

Whether the section is visible in the menu for site visitors.

Section
JSON
{ "section": { "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "revision": "2", "createdDate": "2024-01-14T10:06:30.782Z", "updatedDate": "2024-01-14T10:10:37.372Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally.", "image": null, "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "ec225729-29ae-4a73-bdf6-f873bcabcd53", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "0517e5d4-8fd3-4b28-a743-68cf631e534a", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } }
Did this help?

GET

List Sections


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Retrieves a list of up to 500 sections.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/restaurants/menus-section/v1/sections

Query Params
sectionIdsArray <string>

Section IDs.


paging.limitintegerminimum 0maximum 500format int32

Number of items to load.


paging.cursorstring

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.

Response Object
sectionsArray <Section>

Retrieved sections.


pagingMetadataPagingMetadata

The metadata of the paginated results.

List Sections
Request
cURL
curl -X GET 'https://www.wixapis.com/restaurants/menus-section/v1/sections' \ -H 'Authorization: <AUTH>' \
Response
JSON
{ "sections": [ { "id": "70f12b79-cd30-4750-91ab-1021a16cbbfa", "revision": "2", "createdDate": "2024-01-14T10:06:30.782Z", "updatedDate": "2024-01-14T10:47:58.973Z", "name": "Drinks", "description": "", "additionalImages": [], "itemIds": [ "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86", "e02e2782-3992-4ca5-995d-a1457510d294", "639c0795-581c-4dac-a3ab-0bdf4036753c", "c47a77e5-1df6-4c95-a04f-7cd8bb42da33", "cd75f42f-ecd3-491c-b355-b9afbaa6b474" ] }, { "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "revision": "2", "createdDate": "2024-01-14T10:06:30.782Z", "updatedDate": "2024-01-14T10:10:37.372Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "ec225729-29ae-4a73-bdf6-f873bcabcd53", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "0517e5d4-8fd3-4b28-a743-68cf631e534a", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] }, { "id": "a1e247ea-0c57-498e-a9be-4044ed48bda8", "revision": "2", "createdDate": "2024-01-14T10:06:30.782Z", "updatedDate": "2024-01-14T10:47:02.684Z", "name": "Appetizers", "description": "These dishes are great for sharing", "additionalImages": [], "itemIds": [ "8c19a4e4-3833-4a93-95d3-81b2a4dfd3df", "47595e4a-49aa-4d3d-a4fe-54c50f5eaf43" ] }, { "id": "be9330c1-c3c0-4f76-96cc-b69eac8d88da", "revision": "2", "createdDate": "2024-01-14T10:06:30.782Z", "updatedDate": "2024-01-14T10:47:58.932Z", "name": "Desserts", "description": "Our desserts are made in house by our pastry chef", "additionalImages": [], "itemIds": [ "1c1ca051-b460-4064-b7a2-5f9df47f2d3c", "6593bef5-04e6-4841-a8a0-a9fbe8c5ebf2", "7f2745a2-8b0b-4822-bff1-7dd7a823a677", "d60bb131-b9b9-44f9-ad20-f19c3833f9e9", "34aafd58-af34-4947-b5b6-f33820c17b4b" ] } ], "pagingMetadata": { "count": 4, "cursors": {}, "hasNext": false } }
Did this help?

POST

Create Section


Developer Preview

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

Note: The Sections API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Creates a section.

To create multiple sections at once, use Bulk Create Sections.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/menus-section/v1/sections

Body Params
sectionSectionRequired

Section details.

Response Object
sectionSection

Section.

Create a section
Request
cURL
curl -X POST 'https://www.wixapis.com/restaurants/menus-section/v1/sections' \ -H 'Authorization: <AUTH> \ --data-binary '{ "section": { "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ], "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally" } }'
Response
JSON
{ "section": { "id": "eb7bda36-066c-44cb-8a75-358bae5a273d", "revision": "1", "createdDate": "2024-01-15T07:12:06.826Z", "updatedDate": "2024-01-15T07:12:06.826Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "image": null, "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } }
Event TriggersThis method triggers the following events:
Did this help?

POST

Bulk Create Sections


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Creates multiple sections at once.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/menus-section/v1/bulk/sections/create

Body Params
sectionsArray <Section>RequiredmaxItems 100

Sections details.


returnEntityboolean

Whether to receive the created sections in the response.

Response Object
resultsArray <BulkCreateSectionResult>

Information about the created sections.


bulkActionMetadataBulkActionMetadata

Metadata for the API call.

Create multiple sections
Request
cURL
curl -X POST \ 'https://www.wixapis.com/restaurants/menus-section/v1/bulk/sections/create' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "sections": [ { "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ], "additionalImages": [], "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally" }, { "additionalImages": [], "name": "Appetizers", "description": "These dishes are great for sharing", "itemIds": [] } ], "returnEntity": true }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "d2a0af03-e750-4b49-80b0-91dc6bc47b3f", "originalIndex": 0, "success": true }, "item": { "id": "d2a0af03-e750-4b49-80b0-91dc6bc47b3f", "revision": "1", "createdDate": "2024-01-15T07:22:39.195Z", "updatedDate": "2024-01-15T07:22:39.195Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } }, { "itemMetadata": { "id": "162747cc-d542-4d8a-8c22-05936d8d4f93", "originalIndex": 1, "success": true }, "item": { "id": "162747cc-d542-4d8a-8c22-05936d8d4f93", "revision": "1", "createdDate": "2024-01-15T07:22:39.195Z", "updatedDate": "2024-01-15T07:22:39.195Z", "name": "Appetizers", "description": "These dishes are great for sharing", "additionalImages": [], "itemIds": [] } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Event TriggersThis method triggers the following events:
Did this help?

GET

Get Section


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Retrieves a section by ID.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/restaurants/menus-section/v1/sections/{sectionId}

Path Params
sectionIdstringRequired

Section ID.

Response Object
sectionSection

Section.

Get a section
Request
cURL
curl -X GET https://www.wixapis.com/restaurants/menus-section/v1/sections/9ea7135d-c232-437f-a9c3-33dd87265542 \ -H 'Authorization: <AUTH>' \
Response
JSON
{ "section": { "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "revision": "2", "createdDate": "2024-01-14T10:06:30.782Z", "updatedDate": "2024-01-14T10:10:37.372Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "image": null, "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "ec225729-29ae-4a73-bdf6-f873bcabcd53", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "0517e5d4-8fd3-4b28-a743-68cf631e534a", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } }
Did this help?

DELETE

Delete Section


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Deletes a section.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/restaurants/menus-section/v1/sections/{sectionId}

Path Params
sectionIdstringRequired

Section ID.

Response Object
Returns an empty object.
Delete a section
Request
cURL
curl -X DELETE https://www.wixapis.com/restaurants/menus-section/v1/sections/be9330c1-c3c0-4f76-96cc-b69eac8d88da \ -H 'Authorization: <AUTH>' \
Response
JSON
{}
Event TriggersThis method triggers the following events:
Did this help?

POST

Query Sections


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Retrieves a list of sections given the provided paging, filtering, and sorting. Up to 500 sections can be returned per request.

For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query sections, see API Query Language.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/menus-section/v1/sections/query

Body Params
queryQuery

Query options.

Response Object
sectionsArray <Section>

Retrieved sections.


pagingMetadataPagingMetadata

The metadata of the paginated results.

Query sections
Request
cURL
curl -X POST https://www.wixapis.com/restaurants/menus-section/v1/sections/query \ -H 'Authorization: <AUTH> \ --data-raw '{ "query": { "sort": [], "filter": { "itemIds": { "$hasSome": "b3dfd67a-7c77-43e8-a707-38eb53850d4a" } } } }'
Response
JSON
{ "sections": [ { "id": "89732458-4d43-4f2e-90ba-59007a9287b4", "revision": "1", "createdDate": "2024-01-15T07:21:48.936Z", "updatedDate": "2024-01-15T07:21:48.936Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] }, { "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "revision": "3", "createdDate": "2023-12-17T20:39:33.155Z", "updatedDate": "2024-01-15T08:20:09.358Z", "name": "Desserts", "description": "Our desserts are made in house by our pastry chef", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "ec225729-29ae-4a73-bdf6-f873bcabcd53", "02042f01-58ab-441c-b5db-55f51c855a62", "0517e5d4-8fd3-4b28-a743-68cf631e534a", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] }, { "id": "d2a0af03-e750-4b49-80b0-91dc6bc47b3f", "revision": "1", "createdDate": "2024-01-15T07:22:39.195Z", "updatedDate": "2024-01-15T07:22:39.195Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] }, { "id": "eb7bda36-066c-44cb-8a75-358bae5a273d", "revision": "1", "createdDate": "2024-01-15T07:12:06.826Z", "updatedDate": "2024-01-15T07:12:06.826Z", "name": "Mains", "description": "A diverse range of flavorful dishes which are all sourced daily and locally", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } ], "pagingMetadata": { "count": 4, "cursors": {}, "hasNext": false } }
Did this help?

PATCH

Update Section


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Updates a section.

Each time a section is updated, its revision increments by 1. The existing revision must be included when updating a section. This ensures you're working with the latest section information, and it prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/restaurants/menus-section/v1/sections/{section.id}

Path Params
section.idstringRequired

Section ID.

Body Params
sectionSectionRequired

Section update.

Response Object
sectionSection

Updated section.

Update Section
Request
cURL
curl -X PATCH https://www.wixapis.com/restaurants/menus-section/v1/sections/70f12b79-cd30-4750-91ab-1021a16cbbfa \ -H 'Authorization: <AUTH>' \ --data-binary '{ "section": { "itemIds": [ "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86", "c47a77e5-1df6-4c95-a04f-7cd8bb42da33" ], "additionalImages": [], "id": "70f12b79-cd30-4750-91ab-1021a16cbbfa", "name": "Drinks", "revision": "1" }, "mask": { "paths": [ "itemIds" ] } }'
Response
JSON
{ "section": { "id": "70f12b79-cd30-4750-91ab-1021a16cbbfa", "revision": "2", "createdDate": "2023-12-17T20:39:33.155Z", "updatedDate": "2024-01-15T08:02:19.981Z", "name": "Drinks", "description": "", "additionalImages": [], "itemIds": [ "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86", "c47a77e5-1df6-4c95-a04f-7cd8bb42da33" ] } }
Event TriggersThis method triggers the following events:
Did this help?

POST

Bulk Update Section


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Updates multiple sections at once.

Each time a section is updated, its revision increments by 1. The existing revision must be included when updating a section. This ensures you're working with the latest section information, and it prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/restaurants/menus-section/v1/bulk/sections/update

Body Params
sectionsArray <MaskedSection>RequiredminItems 1maxItems 100

Sections to update.


returnEntityboolean

Whether to receive the updated sections in the response.

Response Object
resultsArray <BulkSectionResult>minItems 1maxItems 100

Information about the updated sections.


bulkActionMetadataBulkActionMetadata

Metadata for the API call.

Update multiple sections
Request
cURL
curl -X POST 'https://www.wixapis.com/restaurants/menus-section/v1/bulk/sections/update' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "sections": [ { "section": { "itemIds": [ "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86" ], "additionalImages": [], "id": "70f12b79-cd30-4750-91ab-1021a16cbbfa", "revision": "3", "name": "Drinks" }, "mask": { "paths": [ "itemIds" ] } }, { "section": { "itemIds": [], "additionalImages": [], "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "name": "Desserts", "description": "Our desserts are made in house by our pastry chef", "revision": "2" }, "mask": { "paths": [ "name", "description" ] } } ], "returnEntity": true }'
Response
JSON
{ "results": [ { "sectionMetadata": { "id": "70f12b79-cd30-4750-91ab-1021a16cbbfa", "originalIndex": 0, "success": true }, "section": { "id": "70f12b79-cd30-4750-91ab-1021a16cbbfa", "revision": "4", "createdDate": "2023-12-17T20:39:33.155Z", "updatedDate": "2024-01-15T08:20:09.358Z", "name": "Drinks", "description": "", "additionalImages": [], "itemIds": ["f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86"] } }, { "sectionMetadata": { "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "originalIndex": 1, "success": true }, "section": { "id": "9ea7135d-c232-437f-a9c3-33dd87265542", "revision": "3", "createdDate": "2023-12-17T20:39:33.155Z", "updatedDate": "2024-01-15T08:20:09.358Z", "name": "Desserts", "description": "Our desserts are made in house by our pastry chef", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "ec225729-29ae-4a73-bdf6-f873bcabcd53", "02042f01-58ab-441c-b5db-55f51c855a62", "0517e5d4-8fd3-4b28-a743-68cf631e534a", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Did this help?

DELETE

Bulk Delete Sections


Developer Preview

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

Note: The Section API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Deletes multiple sections at once.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/restaurants/menus-section/v1/bulk/sections/delete

Query Params
idsArray <string>Required

Section IDs.

Response Object
resultsArray <BulkDeleteSectionResult>

Information about the deleted sections.


bulkActionMetadataBulkActionMetadata

Metadata for the API call.

Delete multiple sections
Request
cURL
curl -X DELETE 'https://www.wixapis.com/restaurants/menus-section/v1/bulk/sections/delete' \ -H 'Authorization: <AUTH> \ --data-raw '{ "ids": [ "1fc4267d-22db-44dc-a872-6484b737718a", "be9330c1-c3c0-4f76-96cc-b69eac8d88da" ] }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "1fc4267d-22db-44dc-a872-6484b737718a", "originalIndex": 0, "success": true } }, { "itemMetadata": { "id": "be9330c1-c3c0-4f76-96cc-b69eac8d88da", "originalIndex": 1, "success": true } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Event TriggersThis method triggers the following events:
Did this help?

Section Created


Developer Preview

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

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.section.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.restaurants.menus.v1.section_created", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

SectionCreated
JSON
{ "id": "540b26d7-fe4e-4918-b932-3857b8620ef1", "entityFqdn": "wix.restaurants.menus.v1.section", "slug": "created", "entityId": "3c4dd316-542e-489d-9ad7-c8c9f4a7b958", "createdEvent": { "entity": { "id": "3c4dd316-542e-489d-9ad7-c8c9f4a7b958", "revision": "1", "createdDate": "2024-01-15T08:13:22.338Z", "updatedDate": "2024-01-15T08:13:22.338Z", "name": "Appetizers", "description": "Great for sharing", "additionalImages": [], "itemIds": [ "b3dfd67a-7c77-43e8-a707-38eb53850d4a", "b8e179cc-f339-4ccb-afa9-d9e04d56c461", "cbbf4358-292c-4e9e-a820-7e73b4c4ac00" ] } }, "eventTime": "2024-01-15T08:13:22.342773976Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "1" }
Did this help?

Section Updated


Developer Preview

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

Triggered when a section is updated.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.section.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.restaurants.menus.v1.section_updated", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

SectionUpdated
JSON
{ "id": "38bec157-74b4-4a1b-af1e-ef1bbf78ffbe", "entityFqdn": "wix.restaurants.menus.v1.section", "slug": "updated", "entityId": "00d36a56-056e-4d7b-96c0-4c0cb92add35", "updatedEvent": { "currentEntity": { "id": "00d36a56-056e-4d7b-96c0-4c0cb92add35", "revision": "3", "createdDate": "2024-01-15T08:05:50.950Z", "updatedDate": "2024-01-15T08:10:27.802Z", "name": "Mains", "description": "", "additionalImages": [], "itemIds": [ "ec43aa3d-7236-46ba-b663-e12fb5032497", "cb014402-3e27-48e0-9d40-a1d7a2184cbf" ] } }, "eventTime": "2024-01-15T08:10:27.808772474Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "3" }
Did this help?

Section Deleted


Developer Preview

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

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.section.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.restaurants.menus.v1.section_deleted", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

SectionDeleted
JSON
{ "id": "e189867d-60c6-43e4-b261-8aafae295b65", "entityFqdn": "wix.restaurants.menus.v1.section", "slug": "deleted", "entityId": "7e093414-c936-47fe-8bcb-0429d6cfad75", "deletedEvent": {}, "eventTime": "2024-01-15T08:13:01.919945790Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "7" }
Did this help?