Skip to main content

OrderItem

One line on an order.

type OrderItem {
id: ID!
type: String
name: String
productId: ID
categoryId: ID
category: String
price: Int
tax: Int
modifiers: [ItemModifier!]!
discounts: [String!]!
notes: [String!]!
voided: Boolean!
refunded: Boolean!
addedBy: Staff
}

Fields​

OrderItem.id ● ID! non-null scalar​

OrderItem.type ● String scalar​

What kind of line this is: product, serviceCharge, gratuity, paidOut or noSale. Others may be added.

OrderItem.name ● String scalar​

OrderItem.productId ● ID scalar​

OrderItem.categoryId ● ID scalar​

OrderItem.category ● String scalar​

OrderItem.price ● Int scalar​

What was charged for this line, including tax and after any discount. Priced modifiers are charged on top of it.

OrderItem.tax ● Int scalar​

OrderItem.modifiers ● [ItemModifier!]! non-null object​

OrderItem.discounts ● [String!]! non-null scalar​

Discounts applied to this line. The price is already reduced by them.

OrderItem.notes ● [String!]! non-null scalar​

OrderItem.voided ● Boolean! non-null scalar​

OrderItem.refunded ● Boolean! non-null scalar​

OrderItem.addedBy ● Staff object​

Needs the read:staff permission.

Member Of​

Order object