Order

  • Business date of this Order (the time component will always return as 00:00:00)

  • Date and time this Order was closed in UTC, null if not yet closed

  • 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

  • Id of the Customer on this Order, or null if there was no assigned Customer

  • Masked account number associated with the Customer on this Order, or null if unavailable

  • Deposits paid for this Order, typically for future date orders

    Properties: 10
  • Maps to the Id of the Destination of this Order

  • Discounts applied to this Order

    Properties: 8
  • Same as Subtotal unless this Order contains inclusive tax, then those taxes would be added to this DisplaySubtotal and subtracted from DisplayTax

  • Same as Tax unless this Order contains inclusive tax, then those taxes won't be counted in this DisplayTax

  • Maps to the Id of the Employee who processed this Order

  • Entries in this Order. An OrderEntry can either be of type OrderItem or an OrderGiftCard.

  • Date and time this Order was first sent to the kitchen in UTC, null if not sent

  • Status of the future date order, null if not applicable

  • Details about the future order, if this Order is a future order

    Properties: 2
  • Gross sales for this Order

  • Number of guests for this Order

  • Fractional number of guests for this Order

  • Unique Id of this Order

  • Unique encoded Id of this Order

  • Unique Id of this order with location identifier removed. This is shorter and generally passed to integrations, including credit processors.

  • True if this Order is closed, False if not

  • True if this Order is a future order, False if not

  • True if this Order is a refund, False if not

  • True if this Order is exempt from taxes, False if not

  • Date and time this Order was last modified in the location's local time

  • Name of this Order

  • Net sales for this Order

  • Order, receipt, or call out number that cashiers use to call the customer for this Order

  • Date and time this Order was opened in UTC

  • Additional loyalty or payment information for this Order, depending on each individual processor\r\nNote:This is a JSON-formatted string.

  • Payments applied to this Order

    Properties: 15
  • Date and time this Order is scheduled for pick up in UTC, null if not applicable

  • Promotions applied to this Order

    Properties: 6
  • Signed 32-bit integers (commonly used integer type).

  • Amount by which the Order was rounded to, reflecting the rounding settings

  • Maps to the Id of the Section of this Order

  • Subtotal of this Order

  • Surcharges applied to this Order

    Properties: 8
  • Total tax for this Order

  • Order taxes applied to this Order

    Properties: 3
  • Tax identifier for the tax-exempt entity

  • Id of the terminal this Order was placed on

  • Id of the till that owns this Order, null if not owned

  • Total for this Order