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 filtering, paging, and sorting.
Search Items has the following default settings, which you can override:
createdDate in ascending order.paging.limit set to 500.paging.offset set to 0.| Property | Capabilities | Filters |
|---|---|---|
businessLocationIds | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
labels._id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
modifierGroups._id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
_createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
_id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
_updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
featured | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
image._id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
orderSettings.inStock | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
visible | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
Search options.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.