Note: The Item API only works with the Wix Restaurants Menus 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.
| Property | Filters | Sort |
|---|---|---|
id | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | Sort: ASC, DESC |
image.id | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | Sort: ASC, DESC |
businessLocationIds | $hasSome, $hasAll, $exists, $isEmpty | Sort: ASC, DESC |
name | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | Sort: ASC, DESC |
description | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | Sort: ASC, DESC |
visible | $eq, $ne, $in, $exists | Sort: ASC, DESC |
featured | $eq, $ne, $in, $exists | Sort: ASC, DESC |
createdDate | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | Sort: ASC, DESC |
updatedDate | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | 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 |
featuredInfo.type | $in, $nin, $eq, $ne, $exists | Sort: ASC, DESC |
labels.id | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | None |
modifierGroups.id | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | None |
priceVariants.variants.variantId | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | None |
externalReferenceInfo.externalAppId | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | None |
externalReferenceInfo.externalEntityId | $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith | None |
externalReferenceInfo.connected | $eq, $ne, $in, $exists | None |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.