CancelOrder

Cancel an open Order at the location.

Request Parameters

OrderId long — Specify the Id of the Order you would like to cancel.
SuppressCancellationEmail bool — (optional) True if you would like the cancellation email suppressed, False if not. Default is False if not specified.

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Success
- 1 — Unknown Error
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
- 101 — OrderId you specified in the request was not found and could not be cancelled
- 102 — The Order you specified has already been sent to the kitchen and could not be cancelled
- 103 — The Order you specified has already been closed and could not be cancelled
- 104 — The Order you specified is currently being edited and could not be cancelled
- 106 — The store did not respond, please try again
- 108 — Payment(s) in the request could not be cancelled, so the Order could not be cancelled

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the CancelOrder request with OrderId.

Responses

text/xml; charset=utf-8

post/CancelOrder

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Ordering.svc?CancelOrder' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/ordering/20140219/IOrderingWebService/CancelOrder"' \
  --data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns="http://www.brinksoftware.com/webservices/ordering/20140219">
    <soapenv:Header/>
    <soapenv:Body>
      <ns:CancelOrder>
        <ns:request>
          <ns:OrderId>12345</ns:OrderId>
          <ns:SuppressCancellationEmail>true</ns:SuppressCancellationEmail>
        </ns:request>
      </ns:CancelOrder>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <CancelOrderResponse xmlns="http://www.brinksoftware.com/webservices/ordering/20140219">
      <CancelOrderResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
      </CancelOrderResult>
    </CancelOrderResponse>
  </s:Body>
</s:Envelope>

SOAP response with cancellation result.