YQueue DocsDevelopers

Schema

Meal (Order)

Represents a meal that has been applied against an order line item.

  • Orders

Overview

object · 7 properties · 0 required

Properties

uuid

string

The unique identifier.

Format uuid

source_meal_uuid

string | null

The UUID of the original (catalog) meal that was used to create this instance. For ad-hoc meals, this field will be `null`.

Format uuid
Nullable Yes

name

string

The name of the meal at the time the order was placed.

Example Burger Combo
Min length 1
Max length 255

unit_price

reference

The value of a single unit of the meal, before the value of modifiers are calculated.

References Money.

modifiers

array

The modifiers that the customer selected for this meal.

Array items

Items

reference

References Modifier (Order).

sub_total

reference

The unit price of the meal, plus the aggregate value of the selected modifiers.

References Money.

total

reference

The total value of the meal (this will be the same as `sub_total`).

References Money.

Used by

Raw YAML
Download source
title: Meal (Order)
type: object
properties:
  uuid:
    type: string
    format: uuid
    description: The unique identifier.
  source_meal_uuid:
    type:
      - string
      - 'null'
    description: |-
      The UUID of the original (catalog) meal that was used to create this instance.

      For ad-hoc meals, this field will be `null`.
    format: uuid
  name:
    type: string
    minLength: 1
    maxLength: 255
    example: Burger Combo
    description: The name of the meal at the time the order was placed.
  unit_price:
    $ref: ./Money.yaml
    description: 'The value of a single unit of the meal, before the value of modifiers are calculated.'
  modifiers:
    type: array
    description: The modifiers that the customer selected for this meal.
    items:
      $ref: ./OrderModifier.yaml
  sub_total:
    $ref: ./Money.yaml
    description: 'The unit price of the meal, plus the aggregate value of the selected modifiers.'
  total:
    $ref: ./Money.yaml
    description: The total value of the meal (this will be the same as `sub_total`).

description: Represents a meal that has been applied against an order line item.
x-tags:
  - Orders

Search documentation

Search across this documentation site.