POST

Query Products

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 100 products, given the provided filtering, sorting, and cursor paging. Pass supported values to the fields array in the request to include those fields in the response.

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.

Notes:

To retrieve a non-visible product (visible: false), your app must have the 'Product v3 read admin' (SCOPE.STORES.PRODUCT_READ_ADMIN) permission scope.
This method does not return variant data. To retrieve variant data, call Get Product or Get Product By Slug for each product individually, or use the Read-Only Variants API for variant-centric queries.

Note: Query Products supports a narrow set of filterable and sortable fields. Unsupported fields return a Field '<fieldName>' is not declared as filterable error. To look up products by name or brand, call Search Products instead. For the full list of supported fields and per-field operators, see Supported Filters and Sorting.

Property	Filters	Sort
`_id`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`handle`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`options._id`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	None
`slug`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`, `$gt`, `$lt`, `$lte`, `$gte`	Sort: `ASC`, `DESC`
`_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`
`visible`	`$eq`, `$ne`, `$exists`, `$in`, `$hasSome`	Sort: `ASC`, `DESC`

Permissions

Learn more about app permissions.

Method Declaration

Copy

Errors

403Permission Denied

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?