SendKitchenInstructions

This is used to send instructions to kitchen display system by passing an open item and required destination.

Request Parameters

DestinationId int — ID of the destination corresponding to the kitchen instruction.
KitchenInstructions Array of KitchenInstruction — Array of KitchenInstruction that needs to be sent to the Kitchen Display System for kitchen staff.
KitchenInstruction Properties
- Instruction string — The text that is required to be shown as an instruction on the Kitchen Display System
- ItemId int — ID of the open item via which the kitchen instruction is being passed

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
- 104 — The store did not respond, please try again
- 109 — No more of item is available

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the SendKitchenInstructions request with DestinationId and KitchenInstructions.

Responses

text/xml; charset=utf-8

post/SendKitchenInstructions

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Ordering.svc?SendKitchenInstructions' \
  --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/SendKitchenInstructions"' \
  --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:SendKitchenInstructions>
        <ns:request>
          <ns:DestinationId>1</ns:DestinationId>
          <ns:KitchenInstructions>
            <ns:KitchenInstruction>
              <ns:Instruction>Test Kitchen Instructions From CloudAPI</ns:Instruction>
              <ns:ItemId>4004218</ns:ItemId>
            </ns:KitchenInstruction>
          </ns:KitchenInstructions>
        </ns:request>
      </ns:SendKitchenInstructions>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

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

SOAP response with kitchen instructions result.