POST v1/Orders/{siteId}/{orderId}

(NOTE: This endpoint will be deprecated and replaced by POST /v2/Orders/{siteId}/{orderId}/Submit in the future). Submit an order to the site that has been previously registered with Aloha Online Ordering (PUT Order).

URI template

v1/Orders/{siteId}/{orderId}?forceATODeposit={forceATODeposit}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	The site that the order will be placed with	integer	Required
orderId	The id of the order	integer	Required
forceATODeposit	Optional parameter denoting if order is required to have deposit	boolean	Default value is False

Body Parameters

Order specific information such as payment information, loyalty information, customer e-mail and vehicular information when applicable

InSubmitOrderInformation

Name	Description	Type	Additional information
PaymentMethods	Information describing the Payment Method	Collection of SecureCreditCardPayment \| ClearCreditCardPayment \| PayAtSitePayment \| PrePaidPayment \| StoredValueCardPayment \| PreAuthorizedPayment	Required
Vehicle	Information describing the Vehicle	Vehicle	None.
LoyaltyNumber		string	None.
SpecialInstructions		string	None.
SendEmail		boolean	None.
FavoriteName		string	None.
UpdateTimeDisabled		boolean	None.
AssignLoyalty	Nullable This flag determines whether loyalty is processed for the order	boolean	None.
ASAPDeliveryTimeEnabled	Information that sets the delivery time to ASAP, this bypasses the earlier available time	boolean	None.
ApplyStoredValue	Whether to apply stored value to the order. Should only be set to true if stored value has not been applied prior to this call.	boolean	None.
LockOrderModification	Determines whether the order can be modified after submission on the POS. This field only applies to RTMS	boolean	None.
Guests	Defines collection of guest information of an order	Collection of Guest	None.
PesOfferId	PES Selected Offer Id	string	None.
PesCouponCode	PES Coupon Code	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PaymentMethods": [
    {
      "$id": "2",
      "PaymentMethod": 1,
      "AccountId": null,
      "AccountNumber": "201:4445228593320007",
      "ExpirationDate": "2017-12-01",
      "SecurityCode": "100",
      "Amount": 0.0,
      "TipAmount": 0.0,
      "OrderOfProcess": 0,
      "ZipCode": null,
      "CardNumber": null,
      "Pin": null,
      "PaymentMethodType": 7,
      "CardNumberMasked": "4445-22xx-xxxx-0007",
      "PreAuthSessionId": null,
      "PreAuthAuthorizationCode": null,
      "PreAuthAuditId": 0,
      "ProcessingType": 1,
      "SaveToken": false,
      "P2PECombo": null,
      "DeviceData": null,
      "ForcePurchase": true,
      "SessionKey": null,
      "PaymentKey": null,
      "CreateToken": false,
      "CardHolderName": null,
      "BillingInfo": null
    },
    {
      "$id": "3",
      "PaymentMethod": 0,
      "AccountId": "1d92429b-c3a2-4cde-b643-34d04cf3ab4e",
      "AccountNumber": null,
      "ExpirationDate": null,
      "SecurityCode": null,
      "Amount": 0.0,
      "TipAmount": 0.0,
      "OrderOfProcess": 0,
      "ZipCode": null,
      "CardNumber": null,
      "Pin": null,
      "PaymentMethodType": null,
      "CardNumberMasked": "4445 22xx xxxx 0007",
      "PreAuthSessionId": null,
      "PreAuthAuthorizationCode": null,
      "PreAuthAuditId": 0,
      "ProcessingType": 1,
      "SaveToken": false,
      "P2PECombo": null,
      "DeviceData": null,
      "ForcePurchase": true,
      "SessionKey": null,
      "PaymentKey": null,
      "CreateToken": false,
      "CardHolderName": null,
      "BillingInfo": null
    }
  ],
  "Vehicle": {
    "$id": "4",
    "Make": "Make",
    "Model": "Model",
    "Color": "Color"
  },
  "LoyaltyNumber": "",
  "SpecialInstructions": "spec",
  "SendEmail": true,
  "FavoriteName": "tf",
  "UpdateTimeDisabled": true,
  "AssignLoyalty": null,
  "ASAPDeliveryTimeEnabled": false,
  "ApplyStoredValue": false,
  "LockOrderModification": null,
  "Guests": null,
  "QuoteId": null,
  "PesOfferId": null,
  "PesCouponCode": null
}

application/xml, text/xml

Sample:

<InSubmitOrderInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <ASAPDeliveryTimeEnabled>false</ASAPDeliveryTimeEnabled>
  <ApplyStoredValue>false</ApplyStoredValue>
  <AssignLoyalty i:nil="true" />
  <EnforceATODeposit>false</EnforceATODeposit>
  <FavoriteName>tf</FavoriteName>
  <Guests xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1" i:nil="true" />
  <LockOrderModification i:nil="true" />
  <LoyaltyNumber></LoyaltyNumber>
  <PaymentMethods xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
    <d2p1:Payment>
      <d2p1:AccountId i:nil="true" />
      <d2p1:AccountNumber>201:4445228593320007</d2p1:AccountNumber>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:BillingInfo i:nil="true" />
      <d2p1:CardHolderName i:nil="true" />
      <d2p1:CardNumber i:nil="true" />
      <d2p1:CardNumberMasked>4445-22xx-xxxx-0007</d2p1:CardNumberMasked>
      <d2p1:CreateToken>false</d2p1:CreateToken>
      <d2p1:DeviceData i:nil="true" />
      <d2p1:ExpirationDate>2017-12-01</d2p1:ExpirationDate>
      <d2p1:ForcePurchase>true</d2p1:ForcePurchase>
      <d2p1:OrderOfProcess>0</d2p1:OrderOfProcess>
      <d2p1:P2PECombo i:nil="true" />
      <d2p1:PaymentKey i:nil="true" />
      <d2p1:PaymentMethod>ClearCreditCardPayment</d2p1:PaymentMethod>
      <d2p1:PaymentMethodType>Visa</d2p1:PaymentMethodType>
      <d2p1:Pin i:nil="true" />
      <d2p1:PreAuthAuditId>0</d2p1:PreAuthAuditId>
      <d2p1:PreAuthAuthorizationCode i:nil="true" />
      <d2p1:PreAuthSessionId i:nil="true" />
      <d2p1:ProcessingType>Token</d2p1:ProcessingType>
      <d2p1:SaveToken>false</d2p1:SaveToken>
      <d2p1:SecurityCode>100</d2p1:SecurityCode>
      <d2p1:SessionKey i:nil="true" />
      <d2p1:TipAmount>0</d2p1:TipAmount>
      <d2p1:ZipCode i:nil="true" />
    </d2p1:Payment>
    <d2p1:Payment>
      <d2p1:AccountId>1d92429b-c3a2-4cde-b643-34d04cf3ab4e</d2p1:AccountId>
      <d2p1:AccountNumber i:nil="true" />
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:BillingInfo i:nil="true" />
      <d2p1:CardHolderName i:nil="true" />
      <d2p1:CardNumber i:nil="true" />
      <d2p1:CardNumberMasked>4445 22xx xxxx 0007</d2p1:CardNumberMasked>
      <d2p1:CreateToken>false</d2p1:CreateToken>
      <d2p1:DeviceData i:nil="true" />
      <d2p1:ExpirationDate i:nil="true" />
      <d2p1:ForcePurchase>true</d2p1:ForcePurchase>
      <d2p1:OrderOfProcess>0</d2p1:OrderOfProcess>
      <d2p1:P2PECombo i:nil="true" />
      <d2p1:PaymentKey i:nil="true" />
      <d2p1:PaymentMethod>SecureCreditCardPayment</d2p1:PaymentMethod>
      <d2p1:PaymentMethodType i:nil="true" />
      <d2p1:Pin i:nil="true" />
      <d2p1:PreAuthAuditId>0</d2p1:PreAuthAuditId>
      <d2p1:PreAuthAuthorizationCode i:nil="true" />
      <d2p1:PreAuthSessionId i:nil="true" />
      <d2p1:ProcessingType>Token</d2p1:ProcessingType>
      <d2p1:SaveToken>false</d2p1:SaveToken>
      <d2p1:SecurityCode i:nil="true" />
      <d2p1:SessionKey i:nil="true" />
      <d2p1:TipAmount>0</d2p1:TipAmount>
      <d2p1:ZipCode i:nil="true" />
    </d2p1:Payment>
  </PaymentMethods>
  <PesCouponCode i:nil="true" />
  <PesOfferId i:nil="true" />
  <QuoteId i:nil="true" />
  <SendEmail>true</SendEmail>
  <SpecialInstructions>spec</SpecialInstructions>
  <UpdateTimeDisabled>true</UpdateTimeDisabled>
  <Vehicle xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
    <d2p1:Color>Color</d2p1:Color>
    <d2p1:Make>Make</d2p1:Make>
    <d2p1:Model>Model</d2p1:Model>
  </Vehicle>
</InSubmitOrderInformation>

Response Information

Resource Description

A confirmation of order submission or a notification of additional required actions based on information garnered at the site. Known internal errors are BadRequest, NotFound

SubmitOrderResults

Name	Description	Type	Additional information
ResultCode	Gets or sets the ResultCode	OrderResultCodes	None.
OrderId	ID of newly created order.	integer	None.
Order	Gets or sets the modified Order to be returned	ExternalOrder	None.
HasFailedItems	Indicates whether or not any of the items in the order failed	boolean	None.
FailedItems	List of all the Items that either failed or have modifiers that failed	Collection of ExternalLineItem	None.
FailedModifiers	List of all the Modifiers that either failed or have modifiers that failed	Collection of ExternalLineItemModifier	None.
ErrorMessage	The error message received from the AppDomain	string	None.
ErrorCode	The site communication error code	integer	None.
AmountDueAtSite	The payment amount due at the site upon pickup	decimal number	None.
LoyaltyResultCode	Result code of loyalty processing	LoyaltyResultCode	None.
LoyaltyMessage	Result code of loyalty processing	string	None.
FinancialSummary	This field will provide all the financial details related to the Order	FinancialSummary	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCode": 0,
  "OrderId": 0,
  "Order": {
    "SiteId": 0,
    "OrderId": 0,
    "MenuId": 0,
    "PromoId": 0,
    "DesignId": 0,
    "OrderMode": 0,
    "LastModifiedTimestamp": "0001-01-01T00:00:00",
    "Status": 0,
    "PromiseDateTime": null,
    "PaymentMode": 0,
    "Customer": null,
    "CustomerAddressForOrder": null,
    "LineItems": null,
    "SubTotalAmount": 0.0,
    "TotalSurchargeAmount": 0.0,
    "TaxAmount": 0.0,
    "PaymentAmount": 0.0,
    "TotalAmount": 0.0,
    "BalanceDueAmount": 0.0,
    "LoyaltyCardNumber": null,
    "LoyaltyRewards": null,
    "OrderSource": null,
    "Destination": null,
    "NextItemLineNumber": 0,
    "SpecialInstructions": null,
    "SubmitCommandId": null,
    "SubmitOrderNumber": null,
    "HumanReadableSubmitOrderNumber": null,
    "SubmitMessage": null,
    "CreationDateTime": null,
    "CompId": 0,
    "CompValue": 0.0,
    "CompName": null,
    "DeliveryFeeAmount": 0.0,
    "TaxJurisdictionId": null,
    "SubmitOrderId": null,
    "IsFailover": false,
    "ReferenceNumber": null,
    "ExternalOrderId": null,
    "ComboItems": null,
    "Guests": null,
    "SVCAmount": 0.0,
    "Payments": null,
    "NextOrderOfProcessing": 0,
    "SiteNotes": null,
    "IsVisible": false,
    "DiscountTotal": 0.0,
    "Metadata": null,
    "ComputedDiscount": 0.0,
    "OrderDiscounts": null,
    "TipAmount": 0.0,
    "PromotionsServiceResponse": null,
    "LoyaltyStatus": null
  },
  "HasFailedItems": false,
  "FailedItems": null,
  "FailedModifiers": null,
  "ErrorMessage": null,
  "ErrorCode": 0,
  "AmountDueAtSite": 0.0,
  "LoyaltyResultCode": 0,
  "LoyaltyMessage": null,
  "FinancialSummary": null
}

application/xml, text/xml

Sample:

<SubmitOrderResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <AmountDueAtSite>0</AmountDueAtSite>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage i:nil="true" />
  <FailedItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1" i:nil="true" />
  <FailedModifiers xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1" i:nil="true" />
  <FinancialSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1" i:nil="true" />
  <HasFailedItems>false</HasFailedItems>
  <LoyaltyMessage i:nil="true" />
  <LoyaltyResultCode>Error</LoyaltyResultCode>
  <OrderId>0</OrderId>
  <ResultCode>Success</ResultCode>
  <Delivery xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response.Delivery" i:nil="true" />
</SubmitOrderResults>