Defines a single OutOrder Is analogous to SubmitOrder in OnlineOrdering
| Name | Type | Additional information | Description |
|---|---|---|---|
| OrderId | long |
None. |
An identifier for this OutOrder that is assigned
|
| OrderNumber | integer |
None. |
An identifier for this OutOrder that is assigned
|
| SequenceNumber | integer |
None. |
Sequence number generated by ATO that is incremented and assigned to each new OutOrder. This number resets at EOD |
| FirstSentToKitchenTime | date |
None. |
Time the OutOrder was first sent to the kitchen for preparation
|
| LastSentToKitchenTime | date |
None. |
Time the OutOrder was last sent to the kitchen for preparation. |
| FirstBumpTime | date |
None. |
The first time the OutOrder was completely bumped from the kitchen system |
| LastBumpTime | date |
None. |
The last time the OutOrder was completely bumped from the kitchen system |
| FirstPaymentTime | date |
None. |
First time a payment was applied to the check in the POS system |
| LastPaymentTime | date |
None. |
Last time a payment was applied to the check in the POS system |
| DispatchTime | date |
None. |
For delivery orders, this value represents the time the associated driver left the store with the OutOrder |
| FulfilledTime | date |
None. |
Time the OutOrder was given to the customer |
| ClosedTime | date |
None. |
Time the OutOrder was closed in ATO |
| ModeCharge | decimal number |
None. |
Amount of the service charge added to the
|
| SubTotal | decimal number |
None. |
Total amount charged for all items in the
|
| DiscountTotal | decimal number |
None. |
Total amount of discounts applied to the OutOrder |
| Tax | decimal number |
None. |
Amount of tax charged to the OutOrder. |
| PaymentTotal | decimal number |
None. |
Total amount of all payments applied to the OutOrder |
| Total | decimal number |
None. |
Total amount charged to the OutOrder,
|
| Tendered | boolean |
None. |
Indicates whether the OutOrder has been completely tendered. |
| DriverId | integer |
None. |
Id of associated driver in the POS system for delivery orders |
| Customer | OutCustomer |
Required |
Customer placing the Order |
| Items | Collection of OutItem |
Required |
Items for the Order |
| FailedItems | Collection of FailedOutItem |
None. |
FailedItems for the Order |
| Tenders | Collection of OutTender |
None. |
Tenders applied to the order |
| Promos | Collection of OutPromo |
None. |
Promos applied to the Order |
| Comps | Collection of OutComp |
None. |
Comps applied to the Order |
| Guests | Collection of OutGuest |
None. |
Collection of guest |
| ReferenceNumber | long |
None. |
An optional OutOrder identifier for tracking use by external applications |
| ExternalOrderId | string |
None. |
An optional free-form order identifier use by external applications |
| OrderTime | date |
None. |
Date and time order was placed |
| PrepTime | integer |
None. |
Amount of time in minutes needed to
|
| DriveTime | integer |
None. |
Amount of time in minutes needed to deliver the order to the customer |
| PromiseDateTime | date |
None. |
Date and time that the customer can expect the order to be ready. |
| OrderSource | OrderSourceType |
None. |
Indicates where an OutOrder originated from |
| Destination | string |
None. |
Order destination |
| SourceId | string |
None. |
The source id |
| DestinationId | string |
None. |
The destination id |
| OrderMode | OrderModeType |
Required |
Mode of the order |
| OverrideModeCharge | decimal number |
None. |
Allows the amount of the order mode
|
| Status | OrderStatus |
None. |
Status of the Order.
|
| AutoSendToKitchen | boolean |
None. |
For InDelay orders, this dictates whether the system will automatically send the order to the kitchen at the prescribed time (if true),
|
| TaxExempt | boolean |
None. |
Indicates that this order should be tax
|
| EstimatedSubTotal | decimal number |
None. |
Not currently used |
| EstimatedTax | decimal number |
None. |
Used to indicate the tax that the external
|
| SpecialInstructions | string |
None. |
Special instructions for the order |
| CheckedIn | boolean |
None. |
Indicates whether the order has been checked in at the site |
| CheckInSummary | string |
None. |
All available check in information concatenated into one field |
| CheckInApplication | string |
None. |
Name of the application used to initiate the check in event |
| CheckInOriginType | string |
None. |
Simple description of the hardware/software situation the above application/system used to originate the event |
| CheckInOriginId | string |
None. |
If applicable, a specific number of the origin type above to help identify it |
| CheckInVectorType | string |
None. |
If applicable, a predefined physical or logical target for the behavior defined around the check in action. |
| CheckInVectorId | string |
None. |
If applicable, a specific number of the Vector Type above to help identify it |
| CheckInIntent | string |
None. |
Specifies actions to be taken by the in store software.
|
| AutoRelease | boolean |
None. |
Indicates whether the order should auto release at the future order release window |
| PartySize | integer |
None. |
Indicates the number of people who will be served by this order |
| ReleaseAwaitingDeposit | boolean |
None. |
If set to true on a future order, the order
|
| AssignAlohaLoyalty | boolean |
None. |
If set to true, ATO will assign any loyalty merits/rewards to the customer's
|
| SiteInformation | SiteInformation |
None. |
Optional SiteInformation element |
| KitchenStatus | KitchenStatus |
None. |
The status of the order in the kitchen |
| LaneIdentifier | string |
None. |
Identifies which lane an order is intended for in a multilane drive-through |