YQueue DocsDevelopers

Schema

Menu

Represents a menu in the catalog.

  • Catalog

Overview

object · 13 properties · 13 required

Properties

uuid

string Required

The menu's unique identifier.

Format uuid
Read only Yes

model_type

enum Required
Read only Yes

Allowed values

menu

name

string Required

The menu's name.

Example Breakfast Menu
Min length 1
Max length 255

tags

array Required

The associated tags.

Unique items Yes
Array items

Items

string
Format uuid

media

oneOf Required

The media file that is associated with the menu.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Media.

media_uuid

string | null Required

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`.

Format uuid
Nullable Yes

external_media_url

string | null Required

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.

Format uri
Nullable Yes
Read only Yes

media_background_colour

string | null Required

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})$
Nullable Yes

position

integer Required

The position of this menu relative to other menus at the same merchant.

Minimum 1
Read only Yes

availability

reference Required

References Availability.

categories

array Required

The associated categories.

Unique items Yes
Array items

Items

string
Format uuid

translations

object Required

The menu's translated attributes.

Nested properties

name

allOf Required
All of
All of 1
reference

References Translation.

All of 2
object

created_at

string Required

The date-time the menu was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
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

Search documentation

Search across this documentation site.