The Items API allows you to manage menu items. Items are various dishes, that are grouped into sections. Each item has its own label and price, and can be customized with item modifiers and price variants
With the Items API, you can:
It's important to note the following point before starting to code:
Menu: A list of food and beverage items available for purchase at a restaurant, café, or other dining establishment.
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.
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 item called "Margherita", this change also needs to be reflected on other sites.
To sync the pizza menu across all sites:
item
object.section.itemIds
array.The following table shows field support for filters and sorting for the item object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $in , $nin | Sortable |
createdDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
updatedDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
name | $eq , $ne , $in , $nin , $startsWith | Sortable |
description | $eq , $ne , $in , $nin , $empty , $startsWith | Sortable |
image | $exists | Sortable |
image.id | $eq , $ne | Sortable |
priceVariants.variants.price | $eq , $ne | Sortable |
priceVariants.variants | $exists | Sortable |
priceVariants.variants.variantId | $hasSome | Sortable |
orderSettings | $exists | Sortable |
orderSettings.inStock | $eq , $ne , $in , $nin , | Sortable |
orderSettings.acceptSpecialRequests | $eq , $ne , $in , $nin | Sortable |
labels | $exists | Sortable |
labels.Id | $hasSome | Sortable |
modifierGroups.id | $hasSome | Sortable |
Related content: API Query Language, Query Items.
Item ID.
Revision number, which increments by 1 each time the item is updated. To prevent conflicting changes, the current revision must be passed when updating the item. Ignored when creating a item.
Date and time the item was created.
Date and time the item was updated.
Item name.
Item description.
Main item image.
Additional item images.
Item labels.
Whether the item is visible in the menu for site visitors.
Online order settings.
Item modifier groups.
Extended fields.
Item price variants.
Item price info.
{
"item": {
"id": "0517e5d4-8fd3-4b28-a743-68cf631e534a",
"revision": "1",
"createdDate": "2024-01-14T12:42:50.267Z",
"updatedDate": "2024-01-14T12:42:50.267Z",
"name": "Classic burger",
"description": "Our classic burger with lettuce, pickles, heirloom tomatoes, served with a side of fries",
"priceVariants": {
"variants": [
{
"variantId": "ef7dc1ed-06df-481a-8ecc-ad87ef9b6b0c",
"priceInfo": { "price": "7.00" }
}
]
},
"image": {
"id": "ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true
},
"modifierGroups": []
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item 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 items.
Item IDs.
Number of items to load.
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.
Whether to return only items that are visible to site visitors.
Items.
The metadata of the paginated results.
curl -X GET https://www.wixapis.com/restaurants/menus-item/v1/items \
-H 'Authorization: <AUTH>'
{
"items": [
{
"id": "02042f01-58ab-441c-b5db-55f51c855a62",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Tofu skewers",
"description": "Grilled tofu skewers, marinated in a blend of soy and sesame with seasonal roast vegetables",
"priceInfo": {"price": "7.50"},
"image": {
"id": "ec845c_70984dcdfdea4c669ffd5536259a8a78~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_70984dcdfdea4c669ffd5536259a8a78~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [
{
"id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975"
}
],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
},
"modifierGroups": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7"
}
]
},
{
"id": "0517e5d4-8fd3-4b28-a743-68cf631e534a",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Classic burger",
"description": "Our classic burger with lettuce, pickles, heirloom tomatoes, served with a side of fries",
"priceVariants": {
"variants": [
{
"variantId": "ef7dc1ed-06df-481a-8ecc-ad87ef9b6b0c",
"priceInfo": {"price": "7.00"}
},
{
"variantId": "869315e7-f1c8-428b-aff0-68bf2d7af067",
"priceInfo": {"price": "7.50"}
},
{
"variantId": "b719995f-fed6-469d-9330-4b9ea9662edf",
"priceInfo": {"price": "9.00"}
}
]
},
"image": {
"id": "ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
},
"modifierGroups": []
},
{
"id": "1c1ca051-b460-4064-b7a2-5f9df47f2d3c",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Classic cheesecake",
"description": "Topped with a layer of raspberry jam & sliced strawberries",
"priceInfo": {"price": "6.5"}
"image": {
"id": "ec845c_812f7b1744e34a038f7e92148c029d71~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_812f7b1744e34a038f7e92148c029d71~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
},
"modifierGroups": []
},
{
"id": "352a961b-18b9-4f5e-8ec0-c6874f2ab496",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Sticky date & ice cream",
"description": "Served with vanilla ice cream, toffee sauce & a peanut crumble",
"priceInfo": {"price": "7.00"},
"image": {
"id": "ec845c_ee7a6fde34d8470582ec419484f74dd9~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_ee7a6fde34d8470582ec419484f74dd9~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [
{
"id": "c05c3ba3-0917-4257-ac8b-4677a754bfbb"
}
],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
},
"modifierGroups": []
},
{
"id": "3cf9df4d-580f-4630-b449-60e951405337",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Tuna sashimi",
"description": "Seared fresh tuna, fresh herbs, and a touch of chili",
"priceVariants": {
"variants": [
{
"variantId": "6c5d9953-a538-4a58-9319-71e624cce5d7",
"priceInfo": {"price": "5.00"}
},
{
"variantId": "e5d0a389-d930-439e-b90a-5aae81c7691c",
"priceInfo": {"price": "7.00"}
}
]
},
"image": {
"id": "ec845c_ed32ae3532964072b9b332e0989bdbf5~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_ed32ae3532964072b9b332e0989bdbf5~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": true,
"acceptSpecialRequests": true,
},
"modifierGroups": [
{
"id": "0f19aead-1d2b-4421-9188-faefdea5bb36"
},
{
"id": "02d34a88-37e9-42b2-8b63-6eda85d73459"
}
]
},
{
"id": "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Healthy smoothie",
"description": "Nourish your body with our selection of healthy smoothies",
"priceInfo": {"price": "3.00"},
"image": {
"id": "",
"url": "",
"height": 0,
"width": 0
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
},
"modifierGroups": []
}
],
"pagingMetadata": {
"count": 23,
"cursors": {},
"hasNext": false
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Creates an item.
To create multiple items at once, use Bulk Create Items.
You can only call this method when authenticated as a Wix app or Wix user identity.
Item details.
Item.
curl -X POST https://www.wixapis.com/restaurants/menus-item/v1/items \
-H 'Authorization: <AUTH>' \
--data-binary '{
"item": {
"name": "Schnitzel",
"description": "Crisp and golden on the outside, in a herb and parmesan crumb",
"priceInfo": {"price": "4.00"},
"image": {
"id": "ec845c_d6fde78f920f48748d383a4906f4c345~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_d6fde78f920f48748d383a4906f4c345~mv2.jpg",
"height": 3335,
"width": 5000,
"altText": null,
"urlExpirationDate": null,
"filename": null,
"sizeInBytes": null
},
"additionalImages": [],
"labels": [],
"visible": null,
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
},
"modifierGroups": [],
"extendedFields": null
}
}'
{
"item": {
"id": "cbbf4358-292c-4e9e-a820-7e75b4551120",
"revision": "1",
"createdDate": "2023-12-04T08:27:34.258Z",
"updatedDate": "2023-12-04T08:27:34.258Z",
"name": "Schnitzel",
"description": "Crisp and golden on the outside, in a herb and parmesan crumb",
"priceInfo": { "price": "4.00" },
"image": {
"id": "ec845c_d6fde78f920f48748d383a4906f4c345~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_d6fde78f920f48748d383a4906f4c345~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true
},
"modifierGroups": []
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Items API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Creates multiple items at once.
You can only call this method when authenticated as a Wix app or Wix user identity.
Items details.
Whether to return entity in the response.
Information about the created items.
Metadata for the API call.
curl -X POST https://www.wixapis.com/restaurants/menus-item/v1/bulk/items/create \
-H 'Authorization: <AUTH>' \
--data-binary '{
"items": [
{
"modifierGroups": [],
"labels": [
{
"id": "6046e53c-4ce3-41f7-9e2a-0f6652fe1175"
}
],
"name": "Tofu skewers",
"description": "Grilled tofu skewers, marinated in a blend of soy and sesame with seasonal roast vegetables",
"priceInfo": {"price": "11"}
},
{
"modifierGroups": [],
"labels": [
{
"id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975"
}
],
"id": "02022fe1-58ab-ee1c-33db-45521c855e11",
"name": "Classic burger",
"description": "Our classic burger with lettuce, pickles, heirloom tomatoes, served with a side of fries",
"priceInfo": {"price": "15"}
}
],
"returnEntity": false
}'
{
"results": [
{
"itemMetadata": {
"id": "02042f01-58ab-441c-33db-55221c855c11",
"originalIndex": 0,
"success": true
}
},
{
"itemMetadata": {
"id": "02022fe1-58ab-ee1c-33db-45521c855e11",
"originalIndex": 1,
"success": true
}
}
],
"bulkActionMetadata": {
"totalSuccesses": 2,
"totalFailures": 0,
"undetailedFailures": 0
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Retrieves an item by ID.
Item ID.
Item.
curl -X GET https://www.wixapis.com/restaurants/menus-item/v1/items/02042f01-58ab-441c-b5db-55f51c855a62 \
-H 'Authorization: <AUTH>'
{
"item": {
"id": "02042f01-58ab-441c-b5db-55f51c855a62",
"revision": "1",
"createdDate": "2023-12-03T21:23:33.861Z",
"updatedDate": "2023-12-03T21:23:33.861Z",
"name": "Tofu skewers",
"description": "Grilled tofu skewers, marinated in a blend of soy and sesame with seasonal roast vegetables",
"priceInfo": { "price": "7.50" },
"image": {
"id": "ec845c_70984dcdfdea4c669ffd5536259a8a78~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_70984dcdfdea4c669ffd5536259a8a78~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [
{
"id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975"
}
],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true
},
"modifierGroups": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7"
}
]
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Deletes an item.
You can only call this method when authenticated as a Wix app or Wix user identity.
Item ID.
curl -X DELETE https://manage.wix.com/_api/menus-item/v1/items/cbbf4358-292c-4e9e-a820-7e75b4551120 \
-H 'Authorization: <AUTH>'
{}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item 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 items given the provided paging, filtering, and sorting. Up to 500 items can be returned per request.
For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query items, see API Query Language.
Query options.
Retrieved items.
The metadata of the paginated results.
curl -X POST https://www.wixapis.com/restaurants/menus-item/v1/items/query \
-H 'Authorization: <AUTH>'
--data-binary '{
"query": {
"sort": [],
"filter": {
"priceInfo": {"price": "7.5"}
}
}
}'
{
"items": [
{
"id": "02042f01-58ab-441c-b5db-55f51c855a10",
"revision": "1",
"createdDate": "2023-12-04T08:12:10.571Z",
"updatedDate": "2023-12-04T08:12:10.571Z",
"name": "Tofu skewers",
"description": "Grilled tofu skewers, marinated in a blend of soy and sesame with seasonal roast vegetables",
"priceInfo": { "price": "7.5" },
"additionalImages": [],
"labels": [
{
"id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975"
}
],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true
},
"modifierGroups": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7"
}
]
}
],
"pagingMetadata": {
"count": 1,
"cursors": {},
"hasNext": false
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Retrieves the number of items that match a specified filter.
If a filter isn't passed in the request, the endpoint returns the count of all items.
Filter for counting items.
Counted items.
curl -X POST https://www.wixapis.com/restaurants/menus-item/v1/items/count \
-H 'Authorization: <AUTH>' \
--data-binary '{
"filter": {
"price": {
"$gte": "5"
}
}
}'
{
"count": 9
}
There is 1 error with this status code:
See the entire list and learn more about Wix errors.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Updates an item.
To update multiple items at once, use Bulk Update Item
Each time an item is updated, its revision increments by 1. The existing revision must be included when updating the item. This ensures you're working with the latest item information, and it prevents unintended overwrites.
You can only call this method when authenticated as a Wix app or Wix user identity.
Item ID.
Item to update.
Updated item.
curl -X PATCH "https://www.wixapis.com/restaurants/menus-item/v1/items/02042f01-58ab-441c-b5db-55f51c855a11?itemId=02042f01-58ab-441c-b5db-55f51c855a11" \
-H 'Authorization: <AUTH>' \
--data-binary '{
"item": {
"modifierGroups": [],
"labels": [],
"additionalImages": [],
"id": "02042f01-58ab-441c-b5db-55f51c855a11",
"revision": "2",
"description": "Grilled Tofu Skewers, expertly marinated in a luscious blend of soy and sesame.",
"name": "Schnitzel",
"priceInfo": {"price": "9"}
},
"mask": {
"paths": [
"price",
"description"
]
}
}'
{
"item": {
"id": "02042f01-58ab-441c-b5db-55f51c855a11",
"revision": "3",
"createdDate": "2023-12-04T08:12:01.896Z",
"updatedDate": "2023-12-04T08:38:47.940Z",
"name": "Tofu skewers",
"description": "Grilled Tofu Skewers, expertly marinated in a luscious blend of soy and sesame.",
"priceInfo": { "price": "9" },
"additionalImages": [],
"labels": [
{
"id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975"
}
],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true
},
"modifierGroups": [
{
"id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7"
}
]
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Updates up to 100 multiple items at once.
Each time an item is updated, its revision increments by 1. The existing revision must be included when updating item. This ensures you're working with the latest item information, and it prevents unintended overwrites.
You can only call this method when authenticated as a Wix app or Wix user identity.
Items to update.
Whether to return entity in the response.
Information about the updated items.
Metadata for the API call.
curl -X POST https://www.wixapis.com/restaurants/menus-item/v1/bulk/items/update \
-H 'Authorization: <AUTH>' \
--data-binary '{
"items": [
{
"item": {
"modifierGroups": [],
"labels": [],
"additionalImages": [],
"id": "639c0795-581c-4dac-a3ab-0bdf4036753c",
"name": "Soft drink",
"revision": "3",
"priceInfo": {"price": "2.5"}
},
"mask": {
"paths": [
"name",
"price"
]
}
},
{
"item": {
"modifierGroups": [],
"labels": [],
"additionalImages": [],
"id": "02042f01-58ab-441c-b5db-55f51c855a62",
"name": "Grilled tofu skewers, marinated in a blend of soy and sesame with seasonal roast vegetables",
"revision": "2",
"visible": false,
"priceInfo": {"price": "7.50"}
},
"mask": {
"paths": [
"visible"
]
}
}
],
"returnEntity": false
}'
{
"results": [
{
"itemMetadata": {
"id": "639c0795-581c-4dac-a3ab-0bdf4036753c",
"originalIndex": 0,
"success": true,
"error": null
},
"item": null
},
{
"itemMetadata": {
"id": "02042f01-58ab-441c-b5db-55f51c855a62",
"originalIndex": 1,
"success": true,
"error": null
},
"item": null
}
],
"bulkActionMetadata": {
"totalSuccesses": 2,
"totalFailures": 0,
"undetailedFailures": 0
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Note: The Item API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.
Deletes multiple items at once.
You can only call this method when authenticated as a Wix app or Wix user identity.
Item IDs.
Information about the deleted items.
Metadata for the API call.
curl -X DELETE https://www.wixapis.com/restaurants/menus-item/v1/bulk/items/delete \
-H 'Authorization: <AUTH>' \
--data-binary '{
"ids": [
"352a961b-18b9-4f5e-8ec0-c6874f2ab496",
"38205e6b-6c54-4176-9b79-4a926737ea8b"
]
}'
{
"results": [
{
"itemMetadata": {
"id": "352a961b-18b9-4f5e-8ec0-c6874f2ab496",
"originalIndex": 0,
"success": true
}
},
{
"itemMetadata": {
"id": "38205e6b-6c54-4176-9b79-4a926737ea8b",
"originalIndex": 1,
"success": true
}
}
],
"bulkActionMetadata": {
"totalSuccesses": 2,
"totalFailures": 0,
"undetailedFailures": 0
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.item
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.restaurants.menus.v1.item_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
}
}
}
{
"id": "420819d4-80ee-4a15-aa52-5d08ae786fa5",
"entityFqdn": "wix.restaurants.menus.v1.item",
"slug": "created",
"entityId": "0517e5d4-8fd3-4b28-a743-68cf631e534a",
"createdEvent": {
"entity": {
"id": "0517e5d4-8fd3-4b28-a743-68cf631e534a",
"revision": "1",
"createdDate": "2024-01-14T12:42:50.267Z",
"updatedDate": "2024-01-14T12:42:50.267Z",
"name": "Classic burger",
"description": "Our classic burger with lettuce, pickles, heirloom tomatoes, served with a side of fries",
"priceVariants": {
"variants": [
{
"variantId": "ef7dc1ed-06df-481a-8ecc-ad87ef9b6b0c",
"priceInfo": { "price": "7.00" }
},
{
"variantId": "869315e7-f1c8-428b-aff0-68bf2d7af067",
"priceInfo": { "price": "7.50" }
},
{
"variantId": "b719995f-fed6-469d-9330-4b9ea9662edf",
"priceInfo": { "price": "9.00" }
}
]
},
"image": {
"id": "ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg",
"url": "https://static.wixstatic.com/media/ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg",
"height": 3335,
"width": 5000
},
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true
},
"modifierGroups": []
}
},
"eventTime": "2024-01-14T12:42:50.316316270Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "1"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.item
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.restaurants.menus.v1.item_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
}
}
}
{
"id": "02729a03-94b4-4046-8fac-4baf0ba06948",
"entityFqdn": "wix.restaurants.menus.v1.item",
"slug": "deleted",
"entityId": "02042f01-58ab-441c-b5db-55f51c855a62",
"deletedEvent": {},
"eventTime": "2024-01-14T12:44:39.802611705Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "2"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when an item is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.menus.v1.item
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.restaurants.menus.v1.item_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
}
}
}
{
"id": "ce9768c8-5b98-4e66-be70-7b00d49e0c68",
"entityFqdn": "wix.restaurants.menus.v1.item",
"slug": "updated",
"entityId": "f2409ddd-5408-48d7-bc8d-e1a10750ecfa",
"updatedEvent": {
"currentEntityAsJson": {
"id": "f2409ddd-5408-48d7-bc8d-e1a10750ecfa",
"revision": "2",
"createdDate": "2024-01-14T12:41:35.833Z",
"updatedDate": "2024-01-14T12:42:53.067Z",
"name": "Tofu skewers",
"description": "Grilled Tofu Skewers, expertly marinated in a luscious blend of soy and sesame.",
"priceInfo": { "price": "13.60" },
"additionalImages": [],
"labels": [],
"orderSettings": {
"inStock": false,
"acceptSpecialRequests": true,
"taxGroupId": "9a5d83fd-8570-482e-81ab-cfa88942ee60"
},
"modifierGroups": []
}
},
"eventTime": "2024-01-14T12:42:53.076984076Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "2"
}