queryModifierGroups( )

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 modifier groups.

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

queryModifierGroups() runs with the following ModifierGroupsQueryBuilder defaults, which you can override:

The following ModifierGroupsQueryBuilder functions are supported for queryModifierGroups(). For a full description of the item modifier group object, see the object returned for the items property in ModifierGroupsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in()
_createdDateeq(),ne(),gt(),ge(),lt(),le()
_updatedDateeq(),ne(),gt(),ge(),lt(),le()
nameeq(),ne(),in(),startsWith()
modifiersexists()
modifiers.idin()
modifiers.preSelectedeq(),ne(),in()
ruleexists()
rule.requiredeq(),ne(),in()
rule.minSelectionseq(),ne()
rule.maxSelectionseq(),ne()
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