queryProducts( )

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.
PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
slugeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
visibleeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
options.ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge()
handleeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge()
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Read products in v3 catalog
Product v3 read admin
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryProductsOptions
Returns
Return Type:ProductsQueryBuilder
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?