title: Modifier
x-tags:
  - Catalog
type: object
description: Defines a modifier that may be associated with modifier groups.
required:
  - uuid
  - model_type
  - name
  - tags
  - media
  - media_uuid
  - external_media_url
  - media_background_colour
  - pricing
  - availability
  - alternative_names
  - description
  - machine_readable_qr_code_data
  - pre_selected
  - force_to_new_label
  - minimum_qty
  - maximum_qty
  - excluded_items
  - sku
  - translations
  - created_at
properties:
  uuid:
    type: string
    format: uuid
    description: The modifier's unique identifier.
    readOnly: true
  model_type:
    enum:
      - modifier
    readOnly: true
  name:
    type: string
    minLength: 1
    maxLength: 255
    description: The modifier's name.
    example: Modifier A
  tags:
    type: array
    uniqueItems: true
    description: The modifier's tags.
    items:
      type: string
      format: uuid
  media:
    oneOf:
      - type: 'null'
      - $ref: ./Media.yaml
    description: The media file that is associated with the modifier.
  media_uuid:
    type:
      - string
      - 'null'
    format: uuid
    description: |-
      The UUID of the media file to associate with the modifier.

      Catalog-management requests use this field to set or remove the association. Responses also include the resolved media file in `media`.
  external_media_url:
    type:
      - string
      - 'null'
    format: uri
    description: |-
      The URI of an external media file that is associated with the modifier.

      This field may be used when `media` is null as a fall-back to display a third-party asset in the application, such as an image hosted on the Deliverect CDN.
    readOnly: true
  media_background_colour:
    type:
      - string
      - 'null'
    description: The background colour that should be displayed behind (or in place of) media assets.
    example: '#F0F0F0'
    pattern: '^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$'
  pricing:
    $ref: ./Pricing.yaml
  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
    description: The modifier's description.
    example: A delicious addition.
  machine_readable_qr_code_data:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    description: The data that should be "baked into" machine readable QR codes for this product.
    example: COFFEE-ESPRESSO
  pre_selected:
    type: boolean
    description: Indicates if the modifier should be pre-selected.
  force_to_new_label:
    type: boolean
    description: Indicates if the modifier should be forced to a new label when printed.
  minimum_qty:
    type: integer
    minimum: 0
    description: Indicates the minimum number of selections the customer must make to "satisfy" the associated modifier group.
  maximum_qty:
    type:
      - integer
      - 'null'
    minimum: 1
    description: The maximum number of selections that the customer may make.
  excluded_items:
    type: array
    uniqueItems: true
    description: The uuids of items that this modifier should not be offered with.
    items:
      type: string
      format: uuid
  sku:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    example: COOLTSHIRT
    description: The stock keeping unit (SKU) for this modifier.
  translations:
    type: object
    description: The modifier'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
    format: date-time
    description: The date-time that the modifier was created.
    readOnly: true
