GetUnavailableItems

Retrieve the list of item IDs that are active but unavailable at the location on current business date. This can be filtered basis specific destination as well.

Request Parameters

DestinationId int? — (optional) Specify the DestinationId to fetch items which are unavailable against that destination. If destination is not passed, all active and unavailable items are returned irrespective of destination.

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 - check that your AccessToken and LocationToken are correct and you are properly provisioned
ItemIds Array of int — Returns the list of item IDs that are active but unavailable.

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetUnavailableItems request with optional DestinationId.

Responses

text/xml; charset=utf-8

post/GetUnavailableItems

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Ordering.svc?GetUnavailableItems' \
  --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/GetUnavailableItems"' \
  --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:GetUnavailableItems>
        <ns:request>
          <ns:DestinationId>1</ns:DestinationId>
        </ns:request>
      </ns:GetUnavailableItems>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetUnavailableItemsResponse xmlns="http://www.brinksoftware.com/webservices/ordering/20140219">
      <GetUnavailableItemsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <ItemIds>
          <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">12345</int>
          <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">67890</int>
        </ItemIds>
      </GetUnavailableItemsResult>
    </GetUnavailableItemsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing unavailable item IDs.