UpdateItemAvailability

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

Request Parameters

Details Array of ItemAvailabilityDetail — Array of ItemAvailabilityDetail objects specifying availability updates.
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

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 — The store did not respond, please try again.

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the UpdateItemAvailability request with Details.

Responses

text/xml; charset=utf-8

post/UpdateItemAvailability

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Ordering.svc?UpdateItemAvailability' \
  --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/UpdateItemAvailability"' \
  --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:UpdateItemAvailability>
        <ns:request>
          <ns:Details>
            <ns:ItemAvailabilityDetail>
              <ns:IsAvailable>true</ns:IsAvailable>
              <ns:ItemId>12345</ns:ItemId>
              <ns:QuantityAvailable>-1</ns:QuantityAvailable>
            </ns:ItemAvailabilityDetail>
          </ns:Details>
        </ns:request>
      </ns:UpdateItemAvailability>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

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

SOAP response with update result.