queryModifiers( )


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 item modifiers.

The queryModifiers() function builds a query to retrieve a list of item modifiers and returns a ModifiersQueryBuilder 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 ModifiersQueryBuilder functions onto the query. ModifiersQueryBuilder functions enable you to filter, sort, and control the results that queryModifiers() returns.

queryModifiers() runs with the following ModifiersQueryBuilder defaults, which you can override:

The following ModifiersQueryBuilder functions are supported for queryModifiers(). For a full description of the item modifier object, see the object returned for the items property in ModifiersQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in()
_createdDateeq(),ne(),gt(),ge(),lt(),le()
_updatedDateeq(),ne(),gt(),ge(),lt(),le()
nameeq(),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
Was this helpful?
Yes
No