POST

Query Items

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

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.

To learn how to query items, see API Query Language.

PropertyFiltersSort
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
businessLocationIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
description$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
visible$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
featured$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
priceVariants.variants.price$in, $nin, $eq, $ne, $existsSort: ASC, DESC
orderSettings.inStock$in, $nin, $eq, $ne, $existsSort: ASC, DESC
orderSettings.acceptSpecialRequests$in, $nin, $eq, $ne, $existsSort: ASC, DESC
labels._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
modifierGroups._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
priceVariants.variants.variantId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteNone
Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?