DELETE v1/FormattedOrders/{storeIdentifier}/{orderId}?cancelIfOrdered={cancelIfOrdered}&timeout={timeout}

DELETE Cancel Order

Cancels a pending order at the POS

URI template

v1/FormattedOrders/{storeIdentifier}/{orderId}?cancelIfOrdered={cancelIfOrdered}&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
cancelIfOrdered	boolean	Default value is False	If true, the specified order will be canceled regardless of whether the order has already been sent to the kitchen. If false, the order will only be canceled if it has not yet been ordered.
timeout	integer	Default value is 30000	The timeout for this command, in milliseconds

Body Parameters

None.

Response Information

Resource Description

A StoreApiResponse

StoreApiResponse

Name	Type	Additional information	Description
TransactionId	globally unique identifier	None.	The Transaction Id on the POS
ResultCode	integer	None.	The Result Code returned by the POS
ResultMessage	string	None.	The message returned by the store api

Response Formats

application/json, text/json

Sample:

{
  "TransactionId": "00000000-0000-0000-0000-000000000000",
  "ResultCode": 123,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<StoreApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses">
  <ResultCode>123</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
  <TransactionId>00000000-0000-0000-0000-000000000000</TransactionId>
</StoreApiResponse>