YQueue DocsDevelopers

Schema

Meal

Defines a meal that may be ordered from a merchant.

  • Catalog

Overview

object · 15 properties · 15 required

Properties

uuid

string Required

The meal's unique identifier.

Format uuid
Read only Yes

model_type

enum Required
Read only Yes

Allowed values

meal

name

string Required

The meal's name.

Example Coffee & Cake Meal
Min length 1
Max length 255

tags

array Required

The meal's tags.

Unique items Yes
Array items

Items

string
Format uuid

media

oneOf Required

The media file that is associated with the meal.

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

pricing

reference Required

References Pricing.

availability

reference Required

References Availability.

description

string | null Required

The meal's description.

Example Treat yourself!
Min length 1
Max length 255
Nullable Yes

machine_readable_qr_code_data

string | null Required

The data that should be "baked into" machine readable QR codes for this product.

Example COFFEE-ESPRESSO
Min length 1
Max length 255
Nullable Yes

modifier_groups

array Required

The modifier groups that should be presented alongside the meal.

Unique items Yes
Array items

Items

string
Format uuid

translations

object Required

The meal's translated attributes.

Nested properties

name

allOf Required
All of
All of 1
reference

References Translation.

All of 2
object

description

allOf Required
All of
All of 1
reference

References Translation.

All of 2
object

created_at

string Required

The date-time that the meal was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
title: Meal
x-tags:
  - Catalog
type: object
description: Defines a meal that may be ordered from a merchant.
required:
  - uuid
  - model_type
  - name
  - tags
  - media
  - media_uuid
  - external_media_url
  - media_background_colour
  - pricing
  - availability
  - description
  - machine_readable_qr_code_data
  - modifier_groups
  - translations
  - created_at
properties:
  uuid:
    type: string
    format: uuid
    description: The meal's unique identifier.
    readOnly: true
  model_type:
    enum:
      - meal
    readOnly: true
  name:
    type: string
    minLength: 1
    maxLength: 255
    example: Coffee & Cake Meal
    description: The meal's name.
  tags:
    type: array
    uniqueItems: true
    description: The meal's tags.
    items:
      type: string
      format: uuid
  media:
    oneOf:
      - type: 'null'
      - $ref: ./Media.yaml
    description: The media file that is associated with the meal.
  media_uuid:
    type:
      - string
      - 'null'
    format: uuid
    description: |-
      The UUID of the media file to associate with the meal.

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

      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})$'
  pricing:
    $ref: ./Pricing.yaml
  availability:
    $ref: ./Availability.yaml
  description:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    example: Treat yourself!
    description: The meal's description.
  machine_readable_qr_code_data:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    description: The data that should be "baked into" machine readable QR codes for this product.
    example: COFFEE-ESPRESSO
  modifier_groups:
    type: array
    uniqueItems: true
    description: The modifier groups that should be presented alongside the meal.
    items:
      type: string
      format: uuid
  translations:
    type: object
    description: The meal's translated attributes.
    required:
      - name
      - description
    properties:
      name:
        allOf:
          - $ref: ./Translation.yaml
          - type: object
            required:
              - en
              - ms
              - zh
              - ta
              - hi
              - ja
              - ko
              - th
      description:
        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 that the meal was created.
    readOnly: true

Search documentation

Search across this documentation site.