Schema
Menu
Represents a menu in the catalog.
Overview
Properties
uuid
The menu's unique identifier.
uuid
Yes
model_type
Yes
Allowed values
menuname
The menu's name.
Breakfast Menu
1
255
tags
The associated tags.
Yes
Array items
Items
uuid
media
The media file that is associated with the menu.
Yes
One of
One of 1
One of 2
References Media.
media_uuid
The UUID of the media file to associate with the menu. Catalog-management requests use this field to set or remove the association. Responses also include the resolved media file in `media`.
uuid
Yes
external_media_url
The URI of an external media file that is associated with the menu. 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.
uri
Yes
Yes
media_background_colour
The background colour that should be displayed behind (or in place of) media assets.
#F0F0F0
^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
Yes
position
The position of this menu relative to other menus at the same merchant.
1
Yes
availability
References Availability.
categories
The associated categories.
Yes
Array items
Items
uuid
translations
The menu's translated attributes.
Nested properties
name
All of
All of 1
References Translation.
All of 2
created_at
The date-time the menu was created.
date-time
Yes
Used by
Raw YAML
title: Menu
x-tags:
- Catalog
type: object
description: Represents a menu in the catalog.
properties:
uuid:
type: string
description: The menu's unique identifier.
format: uuid
readOnly: true
model_type:
enum:
- menu
readOnly: true
name:
type: string
description: The menu's name.
minLength: 1
maxLength: 255
example: Breakfast Menu
tags:
type: array
uniqueItems: true
description: The associated tags.
items:
type: string
format: uuid
media:
oneOf:
- type: 'null'
- $ref: ./Media.yaml
description: The media file that is associated with the menu.
media_uuid:
type:
- string
- 'null'
format: uuid
description: |-
The UUID of the media file to associate with the menu.
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 menu.
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})$'
position:
type: integer
minimum: 1
description: The position of this menu relative to other menus at the same merchant.
readOnly: true
availability:
$ref: ./Availability.yaml
categories:
type: array
uniqueItems: true
description: The associated categories.
items:
type: string
format: uuid
translations:
type: object
description: The menu's translated attributes.
required:
- name
properties:
name:
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 the menu was created.
readOnly: true
required:
- uuid
- model_type
- name
- tags
- media
- media_uuid
- external_media_url
- media_background_colour
- position
- availability
- categories
- translations
- created_at