POST

Query Inventory 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.

Retrieves a list of up to 1,000 inventory items, given the provided filtering, sorting, and cursor paging.

To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.

Learn more about the differences between Query and Search methods.

Property	Filters	Sort
`_id`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`variantId`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`locationId`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`_createdDate`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`	Sort: `ASC`, `DESC`
`_updatedDate`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`	Sort: `ASC`, `DESC`
`trackQuantity`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	Sort: `ASC`, `DESC`
`inStock`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	Sort: `ASC`, `DESC`
`quantity`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`	Sort: `ASC`, `DESC`
`availabilityStatus`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	Sort: `ASC`, `DESC`
`productId`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	Sort: `ASC`, `DESC`
`preorderInfo.enabled`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	Sort: `ASC`, `DESC`
`product.name`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	Sort: `ASC`, `DESC`
`product.directCategoryIds`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$hasAll`	Sort: `ASC`, `DESC`
`product.variantName`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	Sort: `ASC`, `DESC`
`product.variantSku`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	Sort: `ASC`, `DESC`

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?