GetItemAvailability

Get the availability of one or more Items at the location.

Request Parameters

ItemIds List<int> — List one or more Ids of Item(s) to retrieve their availability.

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
Details Array of ItemAvailabilityDetail — Details about the respective Item's availability.
ItemAvailabilityDetail Properties
- IsAvailable bool — True if the Item is still available, False if not. When updating: If you specify True, the default for QuantityAvailable is -1 to indicate an unlimited supply, unless a quantity is specified. If you specify False, the QuantityAvailable is set to 0.
- ItemId int — Maps to the Id of the Item for this ItemAvailabilityDetail
- QuantityAvailable int? — Quantity still available for the Item, or -1 if Item has unlimited availability

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetItemAvailability request with ItemIds.

Responses

text/xml; charset=utf-8

post/GetItemAvailability

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Ordering.svc?GetItemAvailability' \
  --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/GetItemAvailability"' \
  --data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns="http://www.brinksoftware.com/webservices/ordering/20140219"
    xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <soapenv:Header/>
    <soapenv:Body>
      <ns:GetItemAvailability>
        <ns:request>
          <ns:ItemIds>
            <arr:int>12345</arr:int>
          </ns:ItemIds>
        </ns:request>
      </ns:GetItemAvailability>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetItemAvailabilityResponse xmlns="http://www.brinksoftware.com/webservices/ordering/20140219">
      <GetItemAvailabilityResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Details>
          <ItemAvailabilityDetail>
            <ItemId>12345</ItemId>
            <IsAvailable>true</IsAvailable>
            <QuantityAvailable>-1</QuantityAvailable>
          </ItemAvailabilityDetail>
        </Details>
      </GetItemAvailabilityResult>
    </GetItemAvailabilityResponse>
  </s:Body>
</s:Envelope>

SOAP response containing ItemAvailabilityDetail objects.