Schema
Modifier Group
Defines a modifier group that may be associated with items.
Overview
Properties
uuid
string
Required
The modifier group's unique identifier.
Format
uuid
Read only
Yes
model_type
enum
Required
Read only
Yes
Allowed values
modifier_groupname
string
Required
The modifier group's name.
Example
Choose Your Bread
Min length
1
Max length
255
tags
array
Required
The modifier group's tags.
Unique items
Yes
Array items
Items
string
Format
uuid
availability
reference
Required
References Availability.
alternative_names
allOf
Required
All of
All of 1
reference
References Alternative Names.
All of 2
object
description
string | null
Required
The modifier group's description.
Example
Baked fresh in-house daily!
Min length
1
Max length
255
Nullable
Yes
minimum_selections
integer
Required
Indicates the minimum number of selections the customer must make to "satisfy" the group.
Minimum
0
maximum_selections
integer | null
Required
The maximum number of selections that the customer may make.
Minimum
1
Nullable
Yes
modifiers
array
Required
The uuids of modifiers that are associated with the group.
Unique items
Yes
Array items
Items
string
Format
uuid
prerequisite_modifiers
array
Required
The modifiers that must be selected on the same line item before presenting this group.
Unique items
Yes
Array items
Items
string
Format
uuid
translations
object
Required
The modifier group's translated attributes.
Nested properties
name
allOf
Required
All of
All of 1
reference
References Translation.
All of 2
object
description
allOf
Required
All of
All of 1
reference
References Translation.
All of 2
object
created_at
string
Required
The date-time that the modifier group was created.
Format
date-time
Read only
Yes
Used by
Raw YAML
Download source
title: Modifier Group
x-tags:
- Catalog
type: object
description: Defines a modifier group that may be associated with items.
properties:
uuid:
type: string
format: uuid
description: The modifier group's unique identifier.
readOnly: true
model_type:
enum:
- modifier_group
readOnly: true
name:
type: string
description: The modifier group's name.
minLength: 1
maxLength: 255
example: Choose Your Bread
tags:
type: array
uniqueItems: true
description: The modifier group's tags.
items:
type: string
format: uuid
availability:
$ref: ./Availability.yaml
alternative_names:
allOf:
- $ref: ./AlternativeNames.yaml
- type: object
required:
- kitchen_slip
- kitchen_display
description:
type:
- string
- 'null'
minLength: 1
maxLength: 255
example: Baked fresh in-house daily!
description: The modifier group's description.
minimum_selections:
type: integer
minimum: 0
description: Indicates the minimum number of selections the customer must make to "satisfy" the group.
maximum_selections:
type:
- integer
- 'null'
minimum: 1
description: The maximum number of selections that the customer may make.
modifiers:
type: array
uniqueItems: true
description: The uuids of modifiers that are associated with the group.
items:
type: string
format: uuid
prerequisite_modifiers:
type: array
description: The modifiers that must be selected on the same line item before presenting this group.
uniqueItems: true
items:
type: string
format: uuid
translations:
type: object
description: The modifier group's translated attributes.
required:
- name
- description
properties:
name:
allOf:
- $ref: ./Translation.yaml
- type: object
required:
- en
- ms
- zh
- ta
- hi
- ja
- ko
- th
description:
allOf:
- $ref: ./Translation.yaml
- type: object
required:
- en
- ms
- zh
- ta
- hi
- ja
- ko
- th
created_at:
type: string
description: The date-time that the modifier group was created.
format: date-time
readOnly: true
required:
- uuid
- model_type
- name
- tags
- availability
- alternative_names
- description
- minimum_selections
- maximum_selections
- modifiers
- prerequisite_modifiers
- translations
- created_at