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
