POST PlaceOrder/CancelOrders?Terminal={Terminal}

Lets the POS know that the order is to be Cancelled

Request Information

URI Parameters

Name	Type	Description	Additional information
Terminal	string

Body Parameters

CancelApiOrderCommand

Name	Type	Additional information
ApiOrderId	integer	None.
CancelReason	string	None.
Terminal	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ApiOrderId": 1,
  "CancelReason": "sample string 2",
  "Terminal": "sample string 3"
}

application/xml, text/xml

Sample:

<CancelApiOrderCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.ApiOrder.Commands">
  <ApiOrderId>1</ApiOrderId>
  <CancelReason>sample string 2</CancelReason>
  <Terminal>sample string 3</Terminal>
</CancelApiOrderCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIUpdateResultModel

Name	Type	Additional information
ApiOrderId	integer	None.
Updated	boolean	None.
Message	string	None.
CollectionNumber	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ApiOrderId": 1,
  "Updated": true,
  "Message": "sample string 3",
  "CollectionNumber": 1
}

application/xml, text/xml

Sample:

<APIUpdateResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.ApiOrder.Dtos">
  <ApiOrderId>1</ApiOrderId>
  <CollectionNumber>1</CollectionNumber>
  <Message>sample string 3</Message>
  <Updated>true</Updated>
</APIUpdateResultModel>