queryProducts( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Note: To retrieve a non-visible product (visible: false), your app must have the required SCOPE.STORES.PRODUCT_READ_ADMIN permission scope.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith()
_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()
visibleeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
options.ideq(),ne(),exists(),in(),hasSome(),startsWith()
handleeq(),ne(),exists(),in(),hasSome(),startsWith()
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Read products in v3 catalog
Product v3 read admin
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryProductsOptions
Returns
JavaScript
Errors

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

Did this help?