Schema
Modifier Request
On edit, omitted top-level properties retain their existing values.
Overview
Properties
name
Extra Cheese
1
255
tags
UUIDs of tags to associate with the modifier.
All of
All of 1
References Catalog UUID List.
media_uuid
The UUID of an image in the merchant's media library. Supply `null` to remove existing media.
uuid
Yes
media_background_colour
#F0F0F0
^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
Yes
pricing
Nested properties
base
All of
All of 1
References Money.
All of 2
Nested properties
amount
0
4294967295
currency
Must match the merchant's ISO 4217 currency code.
take_away
Yes
One of
One of 1
One of 2
All of
All of 1
References Money.
All of 2
Nested properties
amount
0
4294967295
currency
Must match the merchant's ISO 4217 currency code.
dine_in
Yes
One of
One of 1
One of 2
All of
All of 1
References Money.
All of 2
Nested properties
amount
0
4294967295
currency
Must match the merchant's ISO 4217 currency code.
delivery
Yes
One of
One of 1
One of 2
All of
All of 1
References Money.
All of 2
Nested properties
amount
0
4294967295
currency
Must match the merchant's ISO 4217 currency code.
retail
Yes
One of
One of 1
One of 2
All of
All of 1
References Money.
All of 2
Nested properties
amount
0
4294967295
currency
Must match the merchant's ISO 4217 currency code.
membership
Yes
One of
One of 1
One of 2
All of
All of 1
References Money.
All of 2
Nested properties
amount
0
4294967295
currency
Must match the merchant's ISO 4217 currency code.
availability
References Availability Request.
alternative_names
References Alternative Names.
description
1
255
Yes
machine_readable_qr_code_data
1
255
Yes
pre_selected
force_to_new_label
minimum_qty
Must not exceed a supplied `maximum_qty`. On edit, when the maximum is omitted, this value must not exceed the existing maximum.
0
maximum_qty
A non-null value must be supplied together with `minimum_qty` and must be greater than or equal to it.
1
Yes
excluded_items
UUIDs of items with which this modifier must not be offered.
All of
All of 1
References Catalog UUID List.
sku
1
255
Yes
translations
Nested properties
name
References Translation.
description
References Translation.
Used by
Raw YAML
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