Live
Web Service Documentation
Service: Livesync
Method: GetLiveMultipleStockQuantity
You must be logged in to use this method.
Basic Authentication is supported.
Basic Authentication is supported.
Parameters
Field: FirstStockCodeToGet
(string[40])
String from 0 to 40 characters
This parameter is Optional
Field: LastStockCodeToGet
(string[40])
String from 0 to 40 characters
This parameter is Optional
Possible Return Data
List: ErrorQueue
ErrorNumber
(long integer)
ErrorPosition
(string[255])
ErrorRecordId
(string[255])
ErrorDescription
(string[255])
ErrorRecommendation
(string[255])
List: StockQtyListing
STOCKCODE
(string[40])
DESCRIPTION
(string[60])
AVAILABLEQUANTITY
(long integer)
ACTUALFREESTOCKQUANTITY
(long integer)
RESTOCKDETAILS
(string[60])
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
xmldata
result
Example Request
POST /Livesync HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: cpslive.co.uk
Accept: application/xml
Content-Type: text/xml
Content-Length: length
SOAPAction: https://cpslive.co.uk/GetLiveMultipleStockQuantity
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLiveMultipleStockQuantity>
<FirstStockCodeToGet>value</FirstStockCodeToGet>
<LastStockCodeToGet>value</LastStockCodeToGet>
</GetLiveMultipleStockQuantity>
</soap:Body>
</soap:Envelope>
Authorization: Basic ZGVtbzpkZW1v
Host: cpslive.co.uk
Accept: application/xml
Content-Type: text/xml
Content-Length: length
SOAPAction: https://cpslive.co.uk/GetLiveMultipleStockQuantity
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLiveMultipleStockQuantity>
<FirstStockCodeToGet>value</FirstStockCodeToGet>
<LastStockCodeToGet>value</LastStockCodeToGet>
</GetLiveMultipleStockQuantity>
</soap:Body>
</soap:Envelope>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLiveMultipleStockQuantity_response>
<StockQtyListing>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
</StockQtyListing>
</GetLiveMultipleStockQuantity_response>
</soap:Body>
</soap:Envelope>
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLiveMultipleStockQuantity_response>
<StockQtyListing>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
</StockQtyListing>
</GetLiveMultipleStockQuantity_response>
</soap:Body>
</soap:Envelope>
Example Code - JavaScript
function GetLiveMultipleStockQuantity_soap11(host,xmldata,username,password,result){
fetch(host + "/Livesync", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "text/xml; charset=utf-8",
"Accept": "application/xml;",
"SOAPAction": host + "/GetLiveMultipleStockQuantity",
},
body: xmldata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://cpslive.co.uk"
fetch(host + "/Livesync", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "text/xml; charset=utf-8",
"Accept": "application/xml;",
"SOAPAction": host + "/GetLiveMultipleStockQuantity",
},
body: xmldata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://cpslive.co.uk"
Example Code - CURL
CURL --user Username:Password --header "Content-Type: text/xml; ; charset=utf-8" --header "Accept: application/xml" --header "SOAPAction: cpslive.co.uk/GetLiveMultipleStockQuantity" --data-binary @xmlDataFile.xml https://cpslive.co.uk/Livesync
Try It - Live
User Name
Password
result
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
xmldata
result
Example Request
POST /Livesync HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: cpslive.co.uk
Accept: application/xml
Content-Type: application/soap+xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<GetLiveMultipleStockQuantity>
<FirstStockCodeToGet>value</FirstStockCodeToGet>
<LastStockCodeToGet>value</LastStockCodeToGet>
</GetLiveMultipleStockQuantity>
</soap:Body>
</soap:Envelope>
Authorization: Basic ZGVtbzpkZW1v
Host: cpslive.co.uk
Accept: application/xml
Content-Type: application/soap+xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<GetLiveMultipleStockQuantity>
<FirstStockCodeToGet>value</FirstStockCodeToGet>
<LastStockCodeToGet>value</LastStockCodeToGet>
</GetLiveMultipleStockQuantity>
</soap:Body>
</soap:Envelope>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLiveMultipleStockQuantity_response>
<StockQtyListing>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
</StockQtyListing>
</GetLiveMultipleStockQuantity_response>
</soap:Body>
</soap:Envelope>
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLiveMultipleStockQuantity_response>
<StockQtyListing>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
</StockQtyListing>
</GetLiveMultipleStockQuantity_response>
</soap:Body>
</soap:Envelope>
Example Code - JavaScript
function GetLiveMultipleStockQuantity_soap12(host,xmldata,username,password,result){
fetch(host + "/Livesync", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/soap+xml; charset=utf-8",
"Accept": "application/xml;",
},
body: xmldata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://cpslive.co.uk"
fetch(host + "/Livesync", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/soap+xml; charset=utf-8",
"Accept": "application/xml;",
},
body: xmldata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://cpslive.co.uk"
Example Code - CURL
CURL --user Username:Password --header "Content-Type: application/soap+xml; charset=utf-8" --header "Accept: application/xml" --data-binary @xmlDataFile.xml https://cpslive.co.uk/Livesync
Try It - Live
User Name
Password
result
HTTP POST (XML Response)
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
result
Example Request
POST /GetLiveMultipleStockQuantity HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: cpslive.co.uk
Accept: application/xml
Content-Type: application/x-www-form-urlencoded
Content-Length: length
FirstStockCodeToGet=value&LastStockCodeToGet=value
Authorization: Basic ZGVtbzpkZW1v
Host: cpslive.co.uk
Accept: application/xml
Content-Type: application/x-www-form-urlencoded
Content-Length: length
FirstStockCodeToGet=value&LastStockCodeToGet=value
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<GetLiveMultipleStockQuantity_response>
<StockQtyListing>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
</StockQtyListing>
</GetLiveMultipleStockQuantity_response>
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<GetLiveMultipleStockQuantity_response>
<StockQtyListing>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
<Item>
<STOCKCODE>value</STOCKCODE>
<DESCRIPTION>value</DESCRIPTION>
<AVAILABLEQUANTITY>value</AVAILABLEQUANTITY>
<ACTUALFREESTOCKQUANTITY>value</ACTUALFREESTOCKQUANTITY>
<RESTOCKDETAILS>value</RESTOCKDETAILS>
</Item>
</StockQtyListing>
</GetLiveMultipleStockQuantity_response>
Example Code - JavaScript
function GetLiveMultipleStockQuantity_post(host,postdata,username,password,result){
fetch(host + "/GetLiveMultipleStockQuantity", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/xml;",
},
body: postdata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://cpslive.co.uk"
fetch(host + "/GetLiveMultipleStockQuantity", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/xml;",
},
body: postdata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://cpslive.co.uk"
Example Code - CURL
CURL --user Username:Password --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" --header "Accept: application/xml" --data "FirstStockCodeToGet=value&LastStockCodeToGet=value" https://cpslive.co.uk/GetLiveMultipleStockQuantity
Try It - Live
User Name
Password
FirstStockCodeToGet
LastStockCodeToGet
result
(c) 2024 by CPS Partnership Ltd. All rights reserved