Order
- businessType: stringFormat: date-time
Date Business date of this Order (the time component will always return as 00:00:00)
- closedType: null | stringFormat: date-time
Time Date and time this Order was closed in UTC, null if not yet closed
- countType: integer | stringFormat: int32
Returns one of the following, depending on content of the Order:\r\n0 = Reflects an empty Order (e.g. Entries deleted or voided, Total is 0)\r\n1 = Reflects a full Order
- customerType: null | stringFormat: uuid
Id Id of the Customer on this Order, or null if there was no assigned Customer
- customerType: null | string
Masked Account Number Masked account number associated with the Customer on this Order, or null if unavailable
- depositsType:Properties: 10
Deposits paid for this Order, typically for future date orders
- destinationType: null | integer | stringFormat: int32
Id Maps to the Id of the Destination of this Order
- discountsType:Properties: 8
Discounts applied to this Order
- displayType: number | stringFormat: double
Subtotal Same as Subtotal unless this Order contains inclusive tax, then those taxes would be added to this DisplaySubtotal and subtracted from DisplayTax
- displayType: number | stringFormat: double
Tax Same as Tax unless this Order contains inclusive tax, then those taxes won't be counted in this DisplayTax
- employeeType: null | integer | stringFormat: int32
Id Maps to the Id of the Employee who processed this Order
- entriesType:
Entries in this Order. An OrderEntry can either be of type OrderItem or an OrderGiftCard.
- firstType: null | stringFormat: date-time
Send Time Date and time this Order was first sent to the kitchen in UTC, null if not sent
- futureType: null | string
Date Order Status Status of the future date order, null if not applicable
- futureType:
Order[5 .17+] Properties: 2Details about the future order, if this Order is a future order
- grossType: number | stringFormat: double
Sales Gross sales for this Order
- guestType: integer | stringFormat: int32
Count Number of guests for this Order
- guestType: number | stringFormat: double
Count Fractional Fractional number of guests for this Order
- idType: integer | stringFormat: int64
Unique Id of this Order
- idType: null | string
Encoded Unique encoded Id of this Order
- idType: integer | stringFormat: int32
No Location Unique Id of this order with location identifier removed. This is shorter and generally passed to integrations, including credit processors.
- isType: boolean
Closed True if this Order is closed, False if not
- isType: boolean
Future Order True if this Order is a future order, False if not
- isType: boolean
Refund True if this Order is a refund, False if not
- isType: boolean
Tax Exempt True if this Order is exempt from taxes, False if not
- modifiedType: stringFormat: date-time
Time Date and time this Order was last modified in the location's local time
- nameType: null | string
Name of this Order
- netType: number | stringFormat: double
Sales Net sales for this Order
- numberType: integer | stringFormat: int16
Order, receipt, or call out number that cashiers use to call the customer for this Order
- openedType: stringFormat: date-time
Time Date and time this Order was opened in UTC
- orderType: null | string
Additional Details Additional loyalty or payment information for this Order, depending on each individual processor\r\nNote:This is a JSON-formatted string.
- paymentsType:Properties: 15
Payments applied to this Order
- pickupType: null | stringFormat: date-time
Time Date and time this Order is scheduled for pick up in UTC, null if not applicable
- promotionsType:Properties: 6
Promotions applied to this Order
- refundType: integer | stringFormat: int32
Reason Id Signed 32-bit integers (commonly used integer type).
- roundingType: number | stringFormat: double
Amount by which the Order was rounded to, reflecting the rounding settings
- sectionType: null | integer | stringFormat: int32
Id Maps to the Id of the Section of this Order
- subtotalType: number | stringFormat: double
Subtotal of this Order
- surchargesType:Properties: 8
Surcharges applied to this Order
- taxType: number | stringFormat: double
Total tax for this Order
- taxesType:Properties: 3
Order taxes applied to this Order
- taxType: null | string
Exempt Id Tax identifier for the tax-exempt entity
- terminalType: integer | stringFormat: int32
Id Id of the terminal this Order was placed on
- tillType: null | integer | stringFormat: int32
Number Id of the till that owns this Order, null if not owned
- totalType: number | stringFormat: double
Total for this Order
