YQueue DocsDevelopers

Schema

Menu Request

On edit, omitted top-level properties retain their existing values.

  • Catalog

Overview

object · 7 properties · 0 required

Properties

name

string
Example Breakfast Menu
Min length 1
Max length 255

tags

allOf

UUIDs of tags to associate with the menu.

All of

All of 1

reference

References Catalog UUID List.

media_uuid

string | null

The UUID of an image in the merchant's media library. Supply `null` to remove existing media.

Format uuid
Nullable Yes

media_background_colour

string | null
Example #F0F0F0
Pattern ^#(?:[A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})$
Nullable Yes

availability

reference

References Availability Request.

categories

allOf

Category UUIDs in their desired display order.

All of

All of 1

reference

References Catalog UUID List.

translations

object
Nested properties

name

reference

References Translation.

Used by

Raw YAML
Download source
title: Menu 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: Breakfast Menu
  tags:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: UUIDs of tags to associate with the menu.
  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'
  availability:
    $ref: ./AvailabilityRequest.yaml
  categories:
    allOf:
      - $ref: ./CatalogUuidList.yaml
    description: Category UUIDs in their desired display order.
  translations:
    type: object
    properties:
      name:
        $ref: ./Translation.yaml

Search documentation

Search across this documentation site.