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.
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.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard 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.
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.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard 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 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.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard 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.
Retrieves an item by ID.
Item ID.
Item.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard 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.
Deletes an item.
You can only call this method when authenticated as a Wix app or Wix user identity.
Item ID.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.