NameDescriptionTypeAdditional information
SiteId

The site that the order is being submitted to, value retrieved from get sites

integer

Required

Range: inclusive between 1 and 9.22337203685478E+18

OrderId

Nullable The order id that you are updating, when creating a new order pass in null

integer

Range: inclusive between 0 and 9.22337203685478E+18

DesignId

The web design id that user is ordering from

integer

None.

MenuId

The menu that the user is ordering from

integer

None.

PromiseDateTime

When the order is ready for pick up by the customer, and it follows Prep Time and Capacity management from ATO, Do not send timezone info with this This parameter is required unless valid QuoteId is provided.

date

PromiseDateTime or QuoteId required

LineItems

The list of items that the customer is ordering form

Collection of InOrderLineItem

None.

ComboItems

Distinct List of items in a websales group( i.e Combo Items)

Collection of ComboItem

None.

OrderMode

How the food is being ordered

OrderModeType

Required

UpdateTimeDisabled

Nullable Drives whether we increment the PromiseTime if the user doesn’t submit the order before the promise time, If no value is provided defaults to false

boolean

None.

PaymentMode

How the customer is going to pay for the order

PaymentMode

Required

OrderSource

Nullable How the customer is placing the order

OrderSourceType

None.

Destination

Nullable Identifies the location in store to deliver an order

DestinationType

None.

ShouldManualRelease

States whether an order should automatically be released at the time given, or if it should be held for manual release

boolean

None.

TaxJurisdictionId

Identifies the tax jurisdiction that is used to calculated taxes

integer

None.

Customer

The customer that is placing the order, If the customer already exists send up the customer's First and Last name also

OrderCustomer

Required

CustomerAddressForOrder

Nullable The delivery address if the order is to be delivered

CustomerAddress

None.

SpecialInstructions

Instructions that the customer wants to give the site about the order

string

None.

LoyaltyNumber

Nullable The loyalty card number for the order

string

None.

CompId

Nullable The Comp that is to be placed on the order

integer

None.

Comps

Comps to be applied to the Order. Comps collection and CompId are mutually exclusive. CompId used within Comps collection is the ID of the comp defined in POS, not the ID defined in Aloha Online Ordering admin.

Collection of InComp

None.

Guests

Represents a guest (seat) on the order and the items associated with that guest. Also includes sub-elements for total, tax, and order charge information.

Collection of Guest

None.

ReferenceNumber

Nullable An open field for you want to attach to the order, for example a third party id for this order

integer

None.

ExternalOrderId

Nullable A string field to attach an external id for this order

string

None.

AssignLoyalty

Nullable This flag determines whether loyalty is processed for the order

boolean

None.

DeliveryFeeAmount

The Delivery fee amount to be attached to the order in the scenario UseSiteLevelDeliveryFees is disabled and no Zone fees are set

decimal number

None.

Channel

DEPRECATED. Please use the X-Api-Channel header instead.

string

None.

DineIn

If it's a dinein order

boolean

None.

TableNumber

Dine in table number

integer

None.

TableId

Dine in check id

integer

None.

LoyaltyStatus

Dine in check id

integer

None.