title: Modifier Request
x-tags:
  - Catalog
type: object
description: On edit, omitted top-level properties retain their existing values.
properties:
  name:
    type: string
    minLength: 1
    maxLength: 255
    example: Extra Cheese
  tags:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of tags to associate with the modifier.
  media_uuid:
    type:
      - string
      - 'null'
    format: uuid
    description: The UUID of an image in the merchant's media library. Supply `null` to remove existing media.
  media_background_colour:
    type:
      - string
      - 'null'
    pattern: '^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$'
    example: '#F0F0F0'
  pricing:
    type: object
    required:
      - base
    properties:
      base:
        allOf:
          - $ref: ./Money.yaml
          - type: object
            properties:
              amount:
                minimum: 0
                maximum: 4294967295
              currency:
                description: Must match the merchant's ISO 4217 currency code.
      take_away:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      dine_in:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      delivery:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      retail:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
      membership:
        oneOf:
          - type: 'null'
          - allOf:
              - $ref: ./Money.yaml
              - type: object
                properties:
                  amount:
                    minimum: 0
                    maximum: 4294967295
                  currency:
                    description: Must match the merchant's ISO 4217 currency code.
  availability:
    $ref: ./AvailabilityRequest.yaml
  alternative_names:
    $ref: ./AlternativeNames.yaml
  description:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  machine_readable_qr_code_data:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  pre_selected:
    type: boolean
  force_to_new_label:
    type: boolean
  minimum_qty:
    type: integer
    minimum: 0
    description: Must not exceed a supplied `maximum_qty`. On edit, when the maximum is omitted, this value must not exceed the existing maximum.
  maximum_qty:
    type:
      - integer
      - 'null'
    minimum: 1
    description: A non-null value must be supplied together with `minimum_qty` and must be greater than or equal to it.
  excluded_items:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of items with which this modifier must not be offered.
  sku:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
  translations:
    type: object
    properties:
      name:
        $ref: ./Translation.yaml
      description:
        $ref: ./Translation.yaml
