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.
Returns a list of up to 100 products, given the provided paging, sorting and filtering.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
name | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
slug | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
productType | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
description | eq(),ne(),exists(),in(),hasSome(),startsWith() |
sku | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
price | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
priceData.price | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
numericId | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
collectionIds | eq(),ne(),exists(),in(),hasSome(),hasAll() |
lastUpdated | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
_createdDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge() |
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Stores - all permissions
Manage Products
Read Stores - all read permissions
Read Products
Manage Orders
Learn more about permission scopes.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:ProductsQueryBuilder
Was this helpful?
Yes
No