YQueue DocsDevelopers

Schema

Order

Represents an order that was placed at an outlet.

  • Orders

Overview

object · 36 properties · 0 required

Properties

uuid

string

The unique identifier.

Format uuid

staff_member

oneOf

The staff member currently associated with the order, if any.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Order Staff Member.

revision

integer

The current revision/version of the order.

Minimum 1

status

reference

The current status of the order.

References Order Status.

number

string

The formatted order number.

Example YQ-22
Min length 1
Max length 255

service_type

reference

The service type associated with the order.

References Service Type.

customer

oneOf

The details of the customer that placed the order, if known.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Customer Details.

dispatched_at

string

The date-time that the order was dispatched to the outlet.

Format date-time

closed_off_at

string | null

The date-time that the order was (last) closed off.

Format date-time
Nullable Yes

cancelled_at

string | null

The date-time that the order was last cancelled or merged into another order. Use status to distinguish genuine cancellations from merged sources.

Format date-time
Nullable Yes

merchant_cancellation_reason

string | null

The human-readable reason why the merchant cancelled the order. If this field is non-null, then `cancelled_at` will also be non-null.

Nullable Yes

kitchen_attributes

oneOf
Nullable Yes
One of

One of 1

null

One of 2

reference

References Kitchen Attributes.

collection_attributes

oneOf
Nullable Yes
One of

One of 1

null

One of 2

reference

References Collection Attributes.

delivery_address

oneOf

The delivery address associated with the order (if any).

Nullable Yes
One of

One of 1

null

One of 2

reference

References Address.

cancel_order_on_unavailability

boolean

Indicates if the customer would prefer the order to be completely cancelled if one or more items are unavailable.

client

string | null

The UUID of the client application that placed this order, if known.

Format uuid
Nullable Yes

merchant_notes

string | null

Any notes that the merchant has attached to the order.

Min length 1
Max length 255
Nullable Yes

customer_notes

string | null

Any notes that the customer has attached to the order.

Min length 1
Max length 255
Nullable Yes

customer_question_answers

array

Saved customer question answers. An empty array is returned when no answers have been collected.

Array items

Items

reference

References Customer Question Answer.

customer_receipt_notes

string | null

Any receipt notes that have been attached to the order.

Min length 1
Max length 255
Nullable Yes

line_items

array
Array items

Items

reference

References Line Item (Order).

sub_total

reference

The aggregate value of the sub-total of each line item.

References Money.

discounts

array

The discounts applied to the order.

Unique items Yes
Array items

Items

reference

References Aggregate.

total_discounts

reference

The aggregate value of the discounts applied to each line item.

References Money.

surcharges

array

The surcharges levied against the order.

Unique items Yes
Array items

Items

reference

References Aggregate.

total_surcharges

reference

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

References Money.

taxes

array

The taxes levied against the order.

Unique items Yes
Array items

Items

reference

References Aggregate.

total_taxes

reference

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

References Money.

total

reference

The aggregate value of the total of each line item.

References Money.

amount_paid

reference

The total non-refunded and successful amount paid against the order.

References Money.

cash_rounding

reference

The value of any cash-rounding applied to the order.

References Money.

balance

reference

The balance (outstanding amount) of the order.

References Money.

transactions

array

The transactions that have been processed against the order.

Array items

Items

reference

References Transaction (Order).

events

array

The events that have occured against the order.

Array items

Items

reference

References OrderEvent.

merged_from_order_uuids

array | null

UUIDs of source orders merged into this order. Null when no merge sources are recorded.

Nullable Yes
Unique items Yes
Array items

Items

string
Format uuid

merged_into_order_uuid

string | null

The UUID of the direct target this source was merged into, or null. The target may not have synced yet.

Format uuid
Nullable Yes

Used by

Raw YAML
Download source
title: Order
type: object
x-tags:
  - Orders
description: Represents an order that was placed at an outlet.
properties:
  uuid:
    type: string
    format: uuid
    description: The unique identifier.
  staff_member:
    description: The staff member currently associated with the order, if any.
    oneOf:
      - type: 'null'
      - $ref: ./OrderStaffMember.yaml
  revision:
    type: integer
    minimum: 1
    description: The current revision/version of the order.
  status:
    $ref: ./OrderStatus.yaml
    description: The current status of the order.
  number:
    type: string
    example: YQ-22
    description: The formatted order number.
    minLength: 1
    maxLength: 255
  service_type:
    $ref: ./ServiceType.yaml
    description: The service type associated with the order.
  customer:
    oneOf:
      - type: 'null'
      - type: object
        $ref: ./CustomerDetails.yaml
    description: 'The details of the customer that placed the order, if known.'
  dispatched_at:
    type: string
    format: date-time
    description: The date-time that the order was dispatched to the outlet.
  closed_off_at:
    type:
      - string
      - 'null'
    format: date-time
    description: The date-time that the order was (last) closed off.
  cancelled_at:
    type:
      - string
      - 'null'
    format: date-time
    description: The date-time that the order was last cancelled or merged into another order. Use status to distinguish genuine cancellations from merged sources.
  merchant_cancellation_reason:
    type:
      - string
      - 'null'
    description: |-
      The human-readable reason why the merchant cancelled the order.

      If this field is non-null, then `cancelled_at` will also be non-null.
  kitchen_attributes:
    oneOf:
      - type: 'null'
      - $ref: ./KitchenAttributes.yaml
  collection_attributes:
    oneOf:
      - type: 'null'
      - $ref: ./CollectionAttributes.yaml
  delivery_address:
    oneOf:
      - type: 'null'
      - type: object
        $ref: ./Address.yaml
    description: The delivery address associated with the order (if any).
  cancel_order_on_unavailability:
    type: boolean
    description: Indicates if the customer would prefer the order to be completely cancelled if one or more items are unavailable.
  client:
    type:
      - string
      - 'null'
    format: uuid
    description: 'The UUID of the client application that placed this order, if known.'
  merchant_notes:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    description: Any notes that the merchant has attached to the order.
  customer_notes:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    description: Any notes that the customer has attached to the order.
  customer_question_answers:
    type: array
    description: |-
      Saved customer question answers. An empty array is returned when no answers have been collected.
    items:
      $ref: ./CustomerQuestionAnswer.yaml
  customer_receipt_notes:
    type:
      - string
      - 'null'
    description: Any receipt notes that have been attached to the order.
    minLength: 1
    maxLength: 255
  line_items:
    type: array
    items:
      $ref: ./OrderLineItem.yaml
  sub_total:
    $ref: ./Money.yaml
    description: The aggregate value of the sub-total of each line item.
  discounts:
    type: array
    description: The discounts applied to the order.
    uniqueItems: true
    items:
      $ref: ./Aggregate.yaml
  total_discounts:
    $ref: ./Money.yaml
    description: The aggregate value of the discounts applied to each line item.
  surcharges:
    type: array
    uniqueItems: true
    description: The surcharges levied against the order.
    items:
      $ref: ./Aggregate.yaml
  total_surcharges:
    $ref: ./Money.yaml
    description: The aggregate value of the surcharges levied against each line item.
  taxes:
    type: array
    uniqueItems: true
    description: The taxes levied against the order.
    items:
      $ref: ./Aggregate.yaml
  total_taxes:
    $ref: ./Money.yaml
    description: The aggregate value of the taxes levied against each line item.
  total:
    $ref: ./Money.yaml
    description: The aggregate value of the total of each line item.
  amount_paid:
    $ref: ./Money.yaml
    description: The total non-refunded and successful amount paid against the order.
  cash_rounding:
    $ref: ./Money.yaml
    description: The value of any cash-rounding applied to the order.
  balance:
    $ref: ./Money.yaml
    description: The balance (outstanding amount) of the order.
  transactions:
    type: array
    description: The transactions that have been processed against the order.
    items:
      $ref: ./OrderTransaction.yaml
  events:
    type: array
    description: The events that have occured against the order.
    items:
      $ref: ./OrderEvent.yaml
  merged_from_order_uuids:
    type:
      - array
      - 'null'
    uniqueItems: true
    description: UUIDs of source orders merged into this order. Null when no merge sources are recorded.
    items:
      type: string
      format: uuid
  merged_into_order_uuid:
    type:
      - string
      - 'null'
    format: uuid
    description: The UUID of the direct target this source was merged into, or null. The target may not have synced yet.

Search documentation

Search across this documentation site.