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
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,in() |
_createdDate | eq() ,ne() ,gt() ,ge() ,lt() ,le() |
_updatedDate | eq() ,ne() ,gt() ,ge() ,lt() ,le() |
name | eq() ,ne() ,in() ,startsWith() |
modifiers | exists() |
modifiers.id | in() |
modifiers.preSelected | eq() ,ne() ,in() |
rule | exists() |
rule.required | eq() ,ne() ,in() |
rule.minSelections | eq() ,ne() |
rule.maxSelections | eq() ,ne() |