POST v1/FormattedOrders/{storeIdentifier}/{orderId}/CheckIn?tenderOrder={tenderOrder}&timeout={timeout}

POST Checkin Order

Sends a command to the POS to fire an order

URI template

v1/FormattedOrders/{storeIdentifier}/{orderId}/CheckIn?tenderOrder={tenderOrder}&timeout={timeout}

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	The store to send the command to
orderId	long	Required	The Id of the Order to be fired
tenderOrder	boolean	Default value is False	Whether or not the POS should tender the Order
timeout	integer	Default value is 30000	The timeout for this command, in milliseconds

Body Parameters

The inbound order object

Note: The order object is not required in the body. It is there for when it may become relevant in the future.

InOrder

Name	Type	Additional information	Description
Customer	Customer	Required	Customer placing the Order
Guests	Collection of Guest	None.	Guest information of the order
Items	Collection of Item	Required	Items for the Order
Tenders	Collection of Payment	None.	Tenders applied to the order
Promos	Collection of Promo	None.	Promos applied to the Order
Comps	Collection of Comp	None.	Comps applied to the Order
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 prepare the order
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 charge applied to the order to be specified externally. Overrides order mode charge calculated by the POS or ATO.
Status	OrderStatus	None.	Status of the Order. For future orders, the Status element should be set to “InDelay”. New Immediate orders should omit this element.
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), or whether the order must be manually sent by user action at the site (if false) If not present this is defaulted to true, which was the original behavior
TaxExempt	boolean	None.	Indicates that this order should be tax exempt. The associated customer record at the site must have a tax exempt id assigned to it for the order to be exempted.
EstimatedSubTotal	decimal number	None.	Not currently used
EstimatedTax	decimal number	None.	Used to indicate the tax that the external system estimates will be applied. If this value is specified and the actual tax is more, then a “tax credit” tender will be applied to cover the difference.
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. This acts as more of a verb whereas the Vector is more the object of that verb (Application and Origin would be the noun in this metaphor). Example intents are: DriveThru, Pickup, DineIn
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 will not be auto-released until the final deposit for the order is added
AssignAlohaLoyalty	boolean	None.	If set to true, ATO will assign any loyalty merits/rewards to the customer's Aloha Loyalty account. If false, it will not.
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

Request Formats

application/json, text/json

Sample:

{
  "AttemptId": "2ec37f68-439f-4dc1-9a0c-4df04d99ebae",
  "OrderId": 2,
  "Customer": {
    "$id": "2",
    "ExtraAddresses": [
      {
        "$id": "3",
        "AddressId": 1,
        "AddressType": 0,
        "AddressLine1": "sample string 1",
        "AddressLine2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "Postal": "sample string 5",
        "Country": "sample string 6",
        "BusinessName": "sample string 7",
        "AddressNotes": "sample string 8",
        "IsDefault": true,
        "DepartmentName": "sample string 10"
      },
      {
        "$ref": "3"
      }
    ],
    "Vehicle": {
      "$id": "4",
      "Make": "sample string 1",
      "Model": "sample string 2",
      "Color": "sample string 3"
    },
    "CustomFields": [
      "sample string 1",
      "sample string 2"
    ],
    "CustomerId": 1,
    "ReferenceId": 1,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "EMail": "sample string 3",
    "LoyaltyCardNumber": "sample string 4",
    "TaxId": "sample string 5",
    "Notes": "sample string 6",
    "VoicePhone": "sample string 7",
    "VoicePhoneExtension": "sample string 8",
    "PhoneType": 0,
    "AddressLine1": "sample string 9",
    "AddressLine2": "sample string 10",
    "City": "sample string 11",
    "State": "sample string 12",
    "Postal": "sample string 13",
    "AddressNotes": "sample string 14",
    "AddressType": 0,
    "SaveAddress": true,
    "BusinessName": "sample string 15",
    "DepartmentName": "sample string 16"
  },
  "Guests": [
    {
      "$id": "5",
      "ItemIds": [
        1,
        2
      ],
      "Number": 1,
      "Name": "sample string 1"
    },
    {
      "$ref": "5"
    }
  ],
  "Items": [
    {
      "$id": "6",
      "ItemId": 1,
      "SubItems": [
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ],
      "ReferenceId": 2,
      "PosItemId": 3,
      "ModCodeId": 4,
      "SourceModifierGroupId": 5,
      "Name": "sample string 6",
      "PreciseQuantity": 8.0,
      "Price": 9.0,
      "UseTakeOutPrice": true,
      "Message": "sample string 11"
    },
    {
      "$ref": "6"
    }
  ],
  "Tenders": [
    {
      "$id": "7",
      "ExpirationDate": "sample string 1",
      "ZipCode": "sample string 2",
      "SecurityCode": "sample string 3",
      "ProtectionId": "sample string 4",
      "TenderId": "sample string 5",
      "EncryptedCardNumber": "sample string 6",
      "P2PECombo": 0,
      "PaymentMethodType": 0,
      "AccountNumber": "sample string 8",
      "PayBalance": true,
      "Amount": 10.0,
      "Tip": 11.0,
      "PreAuthorize": true,
      "DepositTenderType": null,
      "WalletType": 0,
      "WalletId": "sample string 14",
      "ProcessingType": 0,
      "CardNumberMasked": "sample string 15"
    },
    {
      "$ref": "7"
    }
  ],
  "Promos": [
    {
      "$id": "8",
      "ItemSelections": [
        {
          "$id": "9",
          "GroupId": 1,
          "ItemReferenceIds": [
            1,
            2
          ]
        },
        {
          "$ref": "9"
        }
      ],
      "IdentifierData": "sample string 1",
      "GuestCount": 2,
      "PromoId": 3,
      "Amount": 4.0
    },
    {
      "$ref": "8"
    }
  ],
  "Comps": [
    {
      "$id": "10",
      "ItemSelections": [
        {
          "$ref": "9"
        },
        {
          "$ref": "9"
        }
      ],
      "CompId": 1,
      "Rate": 2.0,
      "Amount": 3.0
    },
    {
      "$ref": "10"
    }
  ],
  "ReferenceNumber": 3,
  "ExternalOrderId": "sample string 4",
  "OrderTime": "2024-07-27T03:56:34.6949846+00:00",
  "PrepTime": 5,
  "DriveTime": 6,
  "PromiseDateTime": "2024-07-27T03:56:34.6949846+00:00",
  "OrderSource": 0,
  "Destination": "sample string 8",
  "SourceId": "sample string 9",
  "DestinationId": "sample string 10",
  "OrderMode": 0,
  "OverrideModeCharge": 1.0,
  "Status": 0,
  "AutoSendToKitchen": true,
  "TaxExempt": true,
  "EstimatedSubTotal": 13.0,
  "EstimatedTax": 14.0,
  "SpecialInstructions": "sample string 15",
  "CheckedIn": true,
  "CheckInSummary": "sample string 17",
  "CheckInApplication": "sample string 18",
  "CheckInOriginType": "sample string 19",
  "CheckInOriginId": "sample string 20",
  "CheckInVectorType": "sample string 21",
  "CheckInVectorId": "sample string 22",
  "CheckInIntent": "sample string 23",
  "AutoRelease": true,
  "PartySize": 25,
  "ReleaseAwaitingDeposit": true,
  "AssignAlohaLoyalty": true,
  "SiteInformation": {
    "$id": "11",
    "OnlineCompanyCode": "sample string 1",
    "OnlineSiteId": "sample string 2"
  },
  "KitchenStatus": 0,
  "LaneIdentifier": "sample string 28"
}

application/xml, text/xml

Sample:

<InOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Inbound">
  <AssignAlohaLoyalty xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</AssignAlohaLoyalty>
  <AutoRelease xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</AutoRelease>
  <AutoSendToKitchen xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</AutoSendToKitchen>
  <CheckInApplication xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 18</CheckInApplication>
  <CheckInIntent xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 23</CheckInIntent>
  <CheckInOriginId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 20</CheckInOriginId>
  <CheckInOriginType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 19</CheckInOriginType>
  <CheckInSummary xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 17</CheckInSummary>
  <CheckInVectorId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 22</CheckInVectorId>
  <CheckInVectorType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 21</CheckInVectorType>
  <CheckedIn xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</CheckedIn>
  <Destination xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 8</Destination>
  <DestinationId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 10</DestinationId>
  <DriveTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">6</DriveTime>
  <EstimatedSubTotal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">13</EstimatedSubTotal>
  <EstimatedTax xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">14</EstimatedTax>
  <ExternalOrderId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 4</ExternalOrderId>
  <KitchenStatus xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</KitchenStatus>
  <LaneIdentifier xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 28</LaneIdentifier>
  <OrderMode xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</OrderMode>
  <OrderSource xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</OrderSource>
  <OrderTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2024-07-27T03:56:34.6949846+00:00</OrderTime>
  <OverrideModeCharge xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</OverrideModeCharge>
  <PartySize xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">25</PartySize>
  <PrepTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">5</PrepTime>
  <PromiseDateTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2024-07-27T03:56:34.6949846+00:00</PromiseDateTime>
  <ReferenceNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">3</ReferenceNumber>
  <ReleaseAwaitingDeposit xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</ReleaseAwaitingDeposit>
  <SiteInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Models" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
    <d2p1:OnlineCompanyCode>sample string 1</d2p1:OnlineCompanyCode>
    <d2p1:OnlineSiteId>sample string 2</d2p1:OnlineSiteId>
  </SiteInformation>
  <SourceId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 9</SourceId>
  <SpecialInstructions xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 15</SpecialInstructions>
  <Status xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</Status>
  <TaxExempt xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</TaxExempt>
  <Comps>
    <Comp>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">3</Amount>
      <CompId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</CompId>
      <Rate xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2</Rate>
      <ItemSelections>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
      </ItemSelections>
    </Comp>
    <Comp>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">3</Amount>
      <CompId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</CompId>
      <Rate xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2</Rate>
      <ItemSelections>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
      </ItemSelections>
    </Comp>
  </Comps>
  <Customer>
    <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 9</AddressLine1>
    <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 10</AddressLine2>
    <AddressNotes xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 14</AddressNotes>
    <AddressType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</AddressType>
    <BusinessName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 15</BusinessName>
    <City xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 11</City>
    <CustomerId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</CustomerId>
    <DepartmentName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 16</DepartmentName>
    <EMail xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 3</EMail>
    <FirstName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</FirstName>
    <LastName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</LastName>
    <LoyaltyCardNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 4</LoyaltyCardNumber>
    <Notes xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 6</Notes>
    <PhoneType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</PhoneType>
    <Postal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 13</Postal>
    <ReferenceId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</ReferenceId>
    <SaveAddress xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</SaveAddress>
    <State xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 12</State>
    <TaxId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 5</TaxId>
    <VoicePhone xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 7</VoicePhone>
    <VoicePhoneExtension xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 8</VoicePhoneExtension>
    <CustomFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CustomFields>
    <ExtraAddresses>
      <CustomerAddress>
        <AddressId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</AddressId>
        <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</AddressLine1>
        <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</AddressLine2>
        <AddressNotes xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 8</AddressNotes>
        <AddressType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</AddressType>
        <BusinessName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 7</BusinessName>
        <City xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 3</City>
        <Country xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 6</Country>
        <DepartmentName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 10</DepartmentName>
        <IsDefault xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</IsDefault>
        <Postal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 5</Postal>
        <State xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 4</State>
      </CustomerAddress>
      <CustomerAddress>
        <AddressId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</AddressId>
        <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</AddressLine1>
        <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</AddressLine2>
        <AddressNotes xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 8</AddressNotes>
        <AddressType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</AddressType>
        <BusinessName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 7</BusinessName>
        <City xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 3</City>
        <Country xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 6</Country>
        <DepartmentName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 10</DepartmentName>
        <IsDefault xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</IsDefault>
        <Postal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 5</Postal>
        <State xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 4</State>
      </CustomerAddress>
    </ExtraAddresses>
    <Vehicle>
      <Color xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 3</Color>
      <Make xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</Make>
      <Model xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 2</Model>
    </Vehicle>
  </Customer>
  <Guests>
    <Guest>
      <Name xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</Name>
      <Number xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</Number>
      <ItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ItemIds>
    </Guest>
    <Guest>
      <Name xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</Name>
      <Number xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</Number>
      <ItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ItemIds>
    </Guest>
  </Guests>
  <Items>
    <Item z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
      <Message xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 11</Message>
      <ModCodeId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">4</ModCodeId>
      <Name xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 6</Name>
      <PosItemId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">3</PosItemId>
      <PreciseQuantity xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">8</PreciseQuantity>
      <Price xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">9</Price>
      <Quantity xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">7</Quantity>
      <ReferenceId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2</ReferenceId>
      <SourceModifierGroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">5</SourceModifierGroupId>
      <UseTakeOutPrice xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</UseTakeOutPrice>
      <ItemId>1</ItemId>
      <SubItems>
        <Item z:Ref="i1" />
        <Item z:Ref="i1" />
      </SubItems>
    </Item>
    <Item z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
  </Items>
  <OrderId>2</OrderId>
  <Promos>
    <Promo>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">4</Amount>
      <GuestCount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2</GuestCount>
      <IdentifierData xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</IdentifierData>
      <PromoId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">3</PromoId>
      <ItemSelections>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
      </ItemSelections>
    </Promo>
    <Promo>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">4</Amount>
      <GuestCount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">2</GuestCount>
      <IdentifierData xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 1</IdentifierData>
      <PromoId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">3</PromoId>
      <ItemSelections>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
        <ItemSelection>
          <GroupId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">1</GroupId>
          <ItemReferenceIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </ItemReferenceIds>
        </ItemSelection>
      </ItemSelections>
    </Promo>
  </Promos>
  <Tenders>
    <Payment>
      <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 8</AccountNumber>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">10</Amount>
      <CardNumberMasked xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 15</CardNumberMasked>
      <DepositTenderType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <DepositTenderTypeString xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 13</DepositTenderTypeString>
      <PayBalance xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</PayBalance>
      <PaymentMethodType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</PaymentMethodType>
      <PaymentMethodTypeString xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 7</PaymentMethodTypeString>
      <PreAuthorize xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</PreAuthorize>
      <ProcessingType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">CreditCard</ProcessingType>
      <Tip xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">11</Tip>
      <WalletId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 14</WalletId>
      <WalletType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">Unknown</WalletType>
      <EncryptedCardNumber>sample string 6</EncryptedCardNumber>
      <ExpirationDate>sample string 1</ExpirationDate>
      <P2PECombo>NonP2PETransaction</P2PECombo>
      <ProtectionId>sample string 4</ProtectionId>
      <SecurityCode>sample string 3</SecurityCode>
      <TenderId>sample string 5</TenderId>
      <ZipCode>sample string 2</ZipCode>
    </Payment>
    <Payment>
      <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 8</AccountNumber>
      <Amount xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">10</Amount>
      <CardNumberMasked xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 15</CardNumberMasked>
      <DepositTenderType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <DepositTenderTypeString xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 13</DepositTenderTypeString>
      <PayBalance xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</PayBalance>
      <PaymentMethodType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</PaymentMethodType>
      <PaymentMethodTypeString xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 7</PaymentMethodTypeString>
      <PreAuthorize xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">true</PreAuthorize>
      <ProcessingType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">CreditCard</ProcessingType>
      <Tip xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">11</Tip>
      <WalletId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">sample string 14</WalletId>
      <WalletType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">Unknown</WalletType>
      <EncryptedCardNumber>sample string 6</EncryptedCardNumber>
      <ExpirationDate>sample string 1</ExpirationDate>
      <P2PECombo>NonP2PETransaction</P2PECombo>
      <ProtectionId>sample string 4</ProtectionId>
      <SecurityCode>sample string 3</SecurityCode>
      <TenderId>sample string 5</TenderId>
      <ZipCode>sample string 2</ZipCode>
    </Payment>
  </Tenders>
</InOrder>

Response Information

Resource Description

A FormattedOrderResponse

FormattedOrderResponse

Name	Type	Additional information	Description
ApiResult	StoreApiResponse	None.	The result returned by the Api
UpdatedOrder	OutOrder	None.	The updated Order returned by the POS
NewSuggestedTime	date	None.	Set when the attempt to fulfill the Order at the specified PromiseTime would exceed the set Capacity for the restaurant. Only set in a Submit Order call

Response Formats

application/json, text/json

Sample:

{
  "UpdatedOrder": {
    "$id": "2",
    "OrderId": 0,
    "OrderNumber": 0,
    "SequenceNumber": 0,
    "FirstSentToKitchenTime": null,
    "LastSentToKitchenTime": null,
    "FirstBumpTime": null,
    "LastBumpTime": null,
    "FirstPaymentTime": null,
    "LastPaymentTime": null,
    "DispatchTime": null,
    "FulfilledTime": null,
    "ClosedTime": null,
    "ModeCharge": 0.0,
    "SubTotal": 0.0,
    "DiscountTotal": 0.0,
    "Tax": 0.0,
    "PaymentTotal": 0.0,
    "Total": 0.0,
    "Tendered": false,
    "DriverId": 0,
    "Customer": {
      "$id": "3",
      "DeliveryZone": null,
      "ExtraAddresses": null,
      "Vehicle": null,
      "CustomerId": 0,
      "ReferenceId": 0,
      "FirstName": "",
      "LastName": "",
      "EMail": null,
      "LoyaltyCardNumber": "",
      "TaxId": "",
      "Notes": "",
      "VoicePhone": "",
      "VoicePhoneExtension": null,
      "PhoneType": 0,
      "AddressLine1": "",
      "AddressLine2": "",
      "City": "",
      "State": "",
      "Postal": "",
      "AddressNotes": null,
      "AddressType": 0,
      "SaveAddress": false,
      "BusinessName": "",
      "DepartmentName": ""
    },
    "Items": [],
    "FailedItems": [],
    "Tenders": [],
    "Promos": [],
    "Comps": [],
    "Guests": [],
    "ReferenceNumber": 0,
    "ExternalOrderId": null,
    "OrderTime": null,
    "PrepTime": 0,
    "DriveTime": 0,
    "PromiseDateTime": "0001-01-01T00:00:00",
    "OrderSource": 0,
    "Destination": null,
    "SourceId": null,
    "DestinationId": null,
    "OrderMode": 0,
    "OverrideModeCharge": null,
    "Status": 0,
    "AutoSendToKitchen": false,
    "TaxExempt": false,
    "EstimatedSubTotal": 0.0,
    "EstimatedTax": 0.0,
    "SpecialInstructions": null,
    "CheckedIn": false,
    "CheckInSummary": null,
    "CheckInApplication": null,
    "CheckInOriginType": null,
    "CheckInOriginId": null,
    "CheckInVectorType": null,
    "CheckInVectorId": null,
    "CheckInIntent": null,
    "AutoRelease": false,
    "PartySize": 0,
    "ReleaseAwaitingDeposit": false,
    "AssignAlohaLoyalty": false,
    "SiteInformation": null,
    "KitchenStatus": 0
  },
  "NewSuggestedTime": "0001-01-01T00:00:00",
  "ApiResult": {
    "$id": "4",
    "TransactionId": "00000000-0000-0000-0000-000000000000",
    "ResultCode": 0,
    "ResultMessage": "Success"
  }
}

application/xml, text/xml

Sample:

<FormattedOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects.OrderResponses">
  <ApiResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Responses" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects">
    <d2p1:ResultCode>0</d2p1:ResultCode>
    <d2p1:ResultMessage>Success</d2p1:ResultMessage>
    <d2p1:TransactionId>00000000-0000-0000-0000-000000000000</d2p1:TransactionId>
  </ApiResult>
  <NewSuggestedTime>0001-01-01T00:00:00</NewSuggestedTime>
  <UpdatedOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Outbound">
    <AssignAlohaLoyalty xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</AssignAlohaLoyalty>
    <AutoRelease xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</AutoRelease>
    <AutoSendToKitchen xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</AutoSendToKitchen>
    <CheckInApplication i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInIntent i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInOriginId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInOriginType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInSummary i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInVectorId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInVectorType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckedIn xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</CheckedIn>
    <Destination i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <DestinationId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <DriveTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</DriveTime>
    <EstimatedSubTotal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</EstimatedSubTotal>
    <EstimatedTax xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</EstimatedTax>
    <ExternalOrderId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <KitchenStatus xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</KitchenStatus>
    <LaneIdentifier i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <OrderMode xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</OrderMode>
    <OrderSource xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</OrderSource>
    <OrderTime i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <OverrideModeCharge i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <PartySize xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</PartySize>
    <PrepTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</PrepTime>
    <PromiseDateTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0001-01-01T00:00:00</PromiseDateTime>
    <ReferenceNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</ReferenceNumber>
    <ReleaseAwaitingDeposit xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</ReleaseAwaitingDeposit>
    <SiteInformation xmlns:d3p1="http://schemas.datacontract.org/2004/07/StoreConnect.Models" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <SourceId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <SpecialInstructions i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <Status xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</Status>
    <TaxExempt xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</TaxExempt>
    <d2p1:ClosedTime i:nil="true" />
    <d2p1:Comps />
    <d2p1:Customer>
      <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></AddressLine1>
      <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></AddressLine2>
      <AddressNotes i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <AddressType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</AddressType>
      <BusinessName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></BusinessName>
      <City xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></City>
      <CustomerId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</CustomerId>
      <DepartmentName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></DepartmentName>
      <EMail i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <FirstName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></FirstName>
      <LastName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></LastName>
      <LoyaltyCardNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></LoyaltyCardNumber>
      <Notes xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></Notes>
      <PhoneType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</PhoneType>
      <Postal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></Postal>
      <ReferenceId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</ReferenceId>
      <SaveAddress xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</SaveAddress>
      <State xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></State>
      <TaxId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></TaxId>
      <VoicePhone xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></VoicePhone>
      <VoicePhoneExtension i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <d2p1:DeliveryZone i:nil="true" />
      <d2p1:ExtraAddresses i:nil="true" />
      <d2p1:Vehicle i:nil="true" />
    </d2p1:Customer>
    <d2p1:DiscountTotal>0</d2p1:DiscountTotal>
    <d2p1:DispatchTime i:nil="true" />
    <d2p1:DriverId>0</d2p1:DriverId>
    <d2p1:FailedItems />
    <d2p1:FirstBumpTime i:nil="true" />
    <d2p1:FirstPaymentTime i:nil="true" />
    <d2p1:FirstSentToKitchenTime i:nil="true" />
    <d2p1:FulfilledTime i:nil="true" />
    <d2p1:Guests />
    <d2p1:Items />
    <d2p1:LastBumpTime i:nil="true" />
    <d2p1:LastPaymentTime i:nil="true" />
    <d2p1:LastSentToKitchenTime i:nil="true" />
    <d2p1:ModeCharge>0</d2p1:ModeCharge>
    <d2p1:OrderId>0</d2p1:OrderId>
    <d2p1:OrderNumber>0</d2p1:OrderNumber>
    <d2p1:PaymentTotal>0</d2p1:PaymentTotal>
    <d2p1:Promos />
    <d2p1:SequenceNumber>0</d2p1:SequenceNumber>
    <d2p1:SubTotal>0</d2p1:SubTotal>
    <d2p1:Tax>0</d2p1:Tax>
    <d2p1:Tendered>false</d2p1:Tendered>
    <d2p1:Tenders />
    <d2p1:Total>0</d2p1:Total>
  </UpdatedOrder>
</FormattedOrderResponse>