YQueue DocsDevelopers

Schema

Line Item (Order)

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

  • Orders

Overview

object · 16 properties · 0 required

Properties

uuid

string

The unique identifier.

Format uuid

source_item_uuid

string | null

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

Format uuid
Nullable Yes

name

string

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

Example Chocolate Cake
Min length 1
Max length 255

source_category_name

string | null

The saved source category name. Null is displayed as "Unattributed" in category reports.

Example Lunch
Min length 1
Max length 255
Nullable Yes

qty

integer

The quantity that the customer requested.

Minimum 1

unit_price

reference

The value of a single unit of the meal, before the value of modifiers, meals, discounts, surcharges and taxes are calculated.

References Money.

modifiers

array

The modifiers that the customer selected for this item.

Array items

Items

reference

References Modifier (Order).

meal

oneOf

The meal the customer selected for this item, if any.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Meal (Order).

sub_total

reference

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

References Money.

discounts

array

The discounts that have been applied against the line item.

Array items

Items

reference

References Discount (Order).

total_discounts

reference

The aggregate value of the discounts applied against the line item.

References Money.

surcharges

array

The surcharges that have been levied against the line item.

Array items

Items

reference

References Surcharge (Order).

total_surcharges

reference

The aggregate value of the surcharges levied against the line item.

References Money.

taxes

array

The taxes that have been levied against the line item.

Array items

Items

reference

References Tax (Order).

total_taxes

reference

The aggregate value of the taxes levied against the line item.

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: Line Item (Order)
type: object
properties:
  uuid:
    type: string
    format: uuid
    description: The unique identifier.
  source_item_uuid:
    type:
      - string
      - 'null'
    description: |-
      The UUID of the original (catalog) item that was used to create this instance.

      For ad-hoc items, this field will be `null`.
    format: uuid
  name:
    type: string
    minLength: 1
    maxLength: 255
    example: Chocolate Cake
    description: The name of the item at the time the order was placed.
  source_category_name:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    example: Lunch
    description: The saved source category name. Null is displayed as "Unattributed" in category reports.
  qty:
    type: integer
    minimum: 1
    description: The quantity that the customer requested.
  unit_price:
    $ref: ./Money.yaml
    description: 'The value of a single unit of the meal, before the value of modifiers, meals, discounts, surcharges and taxes are calculated.'
  modifiers:
    type: array
    description: The modifiers that the customer selected for this item.
    items:
      $ref: ./OrderModifier.yaml
  meal:
    oneOf:
      - type: 'null'
      - type: object
        $ref: ./OrderMeal.yaml
    description: 'The meal the customer selected for this item, if any.'
  sub_total:
    $ref: ./Money.yaml
    description: 'The unit price of the item, plus the aggregate value of the selected modifiers.'
  discounts:
    type: array
    description: The discounts that have been applied against the line item.
    items:
      $ref: ./OrderDiscount.yaml
  total_discounts:
    $ref: ./Money.yaml
    description: The aggregate value of the discounts applied against the line item.
  surcharges:
    type: array
    description: The surcharges that have been levied against the line item.
    items:
      $ref: ./OrderSurcharge.yaml
  total_surcharges:
    $ref: ./Money.yaml
    description: The aggregate value of the surcharges levied against the line item.
  taxes:
    type: array
    description: The taxes that have been levied against the line item.
    items:
      $ref: ./OrderTax.yaml
  total_taxes:
    $ref: ./Money.yaml
    description: The aggregate value of the taxes levied against the line item.
  total:
    $ref: ./Money.yaml
    description: The total value of the meal (this will be the same as `sub_total`).
description: Represents a line item that has been applied against an order.
x-tags:
  - Orders

Search documentation

Search across this documentation site.