Skip to main content

Order

A closed order, as the till recorded it.

type Order {
id: ID!
number: Int
reference: String
businessDate: Date!
openedAt: DateTime
closedAt: DateTime!
orderMode: String
covers: Int
total: Int
tax: Int
voided: Boolean!
voidedAt: DateTime
items: [OrderItem!]!
payments: [Payment!]!
refundIds: [ID!]!
openedBy: Staff
closedBy: Staff
}

Fields​

Order.id ● ID! non-null scalar​

Order.number ● Int scalar​

Order.reference ● String scalar​

Order.businessDate ● Date! non-null scalar​

Order.openedAt ● DateTime scalar​

Order.closedAt ● DateTime! non-null scalar​

Order.orderMode ● String scalar​

For example Eat in or Takeaway.

Order.covers ● Int scalar​

Order.total ● Int scalar​

What the order came to, including tax and any service charge. A gratuity is not part of it.

Order.tax ● Int scalar​

Order.voided ● Boolean! non-null scalar​

Order.voidedAt ● DateTime scalar​

Order.items ● [OrderItem!]! non-null object​

Order.payments ● [Payment!]! non-null object​

Order.refundIds ● [ID!]! non-null scalar​

Refunds made against this order. Read them with refunds.

Order.openedBy ● Staff object​

Needs the read:staff permission.

Order.closedBy ● Staff object​

Needs the read:staff permission.

Member Of​

OrderPage object