queryItems( )

Developer Preview

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

Creates a query to retrieve a list of items.

The queryItems() function builds a query to retrieve a list of items and returns a ItemsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() function.

You can refine the query by chaining ItemsQueryBuilder functions onto the query. ItemsQueryBuilder functions enable you to filter, sort, and control the results that queryItems() returns.

queryItems() runs with the following ItemsQueryBuilder defaults, which you can override:

The following ItemsQueryBuilder functions are supported for queryItems(). For a full description of the item object, see the object returned for the items property in ItemsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
priceVariants.variantsexists()
priceVariants.variants.priceeq(),ne()
_ideq(),ne(),in()
_createdDateeq(),ne(),gt(),le(),lt()
_updatedDateeq(),ne(),gt(),le(),lt()
nameeq(),ne(),in(),startsWith()
descriptioneq(),ne(),in(),startsWith()
imageexists()
image.ideq(),ne()
labelsexists()
orderSettingsexists()
orderSettings.inStockeq(),ne(),in()
orderSettings.acceptSpecialRequestseq(),ne(),in()
Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:ItemsQueryBuilder
Was this helpful?
Yes
No