GetOrderBumpTimes

This call is to retrieve an array of OrderBumpTime objects for a business date.

Request Parameters

BumpTime DateTimeOffset — (optional) Only bumps occurring on or after the specified time will be retrieved
BusinessDate DateTime — Specify the business date you would like to retrieve bumps from

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
OrderBumpTimes Array of OrderBumpTime — Order bump times for this business date
OrderBumpTime Properties
- BumpTime DateTimeOffset — Bump time of the order
- FirstSendTime DateTimeOffset — First send time of the order
- KitchenQueueId int — Id of the kitchen queue from which the order was bumped
- OrderId long — Maps to the Id of Order
- SendNumber short — Send number of the order bump
- SendTime DateTimeOffset — Send time of the order
ResultCode int — Returns one of the following:
- 0 — Request went through successfully
- 1 — Request returned an unknown error
- 2 — Request was not valid
- 3 — Server is currently unavailable and unable to receive the request
- 4 — Access Denied

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetOrderBumpTimes request with BusinessDate.

Responses

text/xml; charset=utf-8

post/GetOrderBumpTimes

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Kitchen.svc?GetOrderBumpTimes' \
  --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/kitchen/v1/IKitchenWebService/GetOrderBumpTimes"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v1="http://www.brinksoftware.com/webservices/kitchen/v1"
    xmlns:sys="http://schemas.datacontract.org/2004/07/System">
    <soapenv:Header/>
    <soapenv:Body>
      <v1:GetOrderBumpTimes>
        <v1:request>
          <v1:BusinessDate>2024-01-15</v1:BusinessDate>
        </v1:request>
      </v1:GetOrderBumpTimes>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetOrderBumpTimesResponse xmlns="http://www.brinksoftware.com/webservices/kitchen/v1">
      <GetOrderBumpTimesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <OrderBumpTimes>
          <OrderBumpTime>
            <BumpTime>2024-01-15T11:45:30</BumpTime>
            <FirstSendTime>2024-01-15T11:30:00</FirstSendTime>
            <KitchenQueueId>1</KitchenQueueId>
            <OrderId>100012345</OrderId>
            <SendNumber>1</SendNumber>
            <SendTime>2024-01-15T11:30:00</SendTime>
          </OrderBumpTime>
        </OrderBumpTimes>
      </GetOrderBumpTimesResult>
    </GetOrderBumpTimesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of OrderBumpTime objects.