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

Updates the pos order status of an order

URI template

v1/Orders/UpdateStatus/{siteId}/{orderId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	The AO internal site id where the customer placed the order	integer	Required
orderId	The AO internal order id of the which status need to be changed	integer	Required

Body Parameters

InAboveStoreMessage

Name	Description	Type	Additional information
AtoOrderId	Order Id identifiable by ATO	integer	None.
ReferenceId	Reference Id property	integer	None.
AlohaOrderNumber	Aloha Order Number	integer	None.
Status	New status of the order. Possible Values: [None, InDelay, Cooking, Prepared, InTransit, Fulfilled, Closed, PreDelay, KitchenDelay, Released, Canceled, Standing, Releasing, Abandoned, Expired]	string	Required
CustomerName	Name of the customer	string	None.
PhoneNumber	Voice phone of the customer	string	None.
OrderAddress	Delivery address of the order	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AtoOrderId": 1,
  "ReferenceId": 2,
  "AlohaOrderNumber": 3,
  "Status": "sample string 4",
  "CustomerName": "sample string 5",
  "PhoneNumber": "sample string 6",
  "OrderAddress": "sample string 7"
}

application/xml, text/xml

Sample:

<InAboveStoreMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
  <AlohaOrderNumber>3</AlohaOrderNumber>
  <AtoOrderId>1</AtoOrderId>
  <CustomerName>sample string 5</CustomerName>
  <OrderAddress>sample string 7</OrderAddress>
  <PhoneNumber>sample string 6</PhoneNumber>
  <ReferenceId>2</ReferenceId>
  <Status>sample string 4</Status>
</InAboveStoreMessage>

Response Information

Resource Description

Information about the status update

ResponseOfInUpdateStatusResponse

Name	Type	Additional information
Verbose	string	None.
Message	string	None.
ErrorCode	integer	None.
Result	InUpdateStatusResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Verbose": "sample string 1",
  "Message": "sample string 2",
  "ErrorCode": 3,
  "Result": {
    "$id": "2",
    "PreviousStatus": "sample string 4",
    "UpdatedStatus": "sample string 5"
  }
}

application/xml, text/xml

Sample:

<ResponseOfInUpdateStatusResponseaLfO5MmV xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <ErrorCode>3</ErrorCode>
  <Message>sample string 2</Message>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound">
    <d2p1:PreviousStatus>sample string 4</d2p1:PreviousStatus>
    <d2p1:UpdatedStatus>sample string 5</d2p1:UpdatedStatus>
  </Result>
  <Verbose>sample string 1</Verbose>
</ResponseOfInUpdateStatusResponseaLfO5MmV>