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.
| Field | Supported Filters | Sort |
|---|---|---|
id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
image.id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
businessLocationIds | $eq, $ne, $exists, $in, $any, $all | Sort: ASC, DESC |
name | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
description | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
visible | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
featured | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
createdDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
updatedDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
priceVariants.variants.price | $in, $nin, $eq, $ne, $exists | Sort: ASC, DESC |
orderSettings.inStock | $in, $nin, $eq, $ne, $exists | Sort: ASC, DESC |
orderSettings.acceptSpecialRequests | $in, $nin, $eq, $ne, $exists | Sort: ASC, DESC |
labels.id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
modifierGroups.id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
priceVariants.variants.variantId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
externalReferenceInfo.externalAppId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
externalReferenceInfo.externalEntityId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
externalReferenceInfo.connected | $eq, $ne, $exists, $in, $any | Sort: ✗ |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.