Live
Web Service Documentation
Service: Livesync
Method: GetLiveStockQuantity
Parameters
Field: StockCodeToGet
(string[40])
String from 0 to 40 characters
This parameter is Required
Possible Return Data
List: ErrorQueue
ErrorNumber
(long integer)
ErrorPosition
(string[255])
ErrorRecordId
(string[255])
ErrorDescription
(string[255])
ErrorRecommendation
(string[255])
Field: StockCode
(not set [0])
Field: StockDescription
(not set [0])
Field: StockQuantityAvailable
(not set [0])
Field: RestockDetails
(not set [0])
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Example Request
POST /Livesync HTTP/1.1
Host: cpslive.co.uk
Accept: application/xml
Content-Type: text/xml
Content-Length: length
SOAPAction: https://cpslive.co.uk/GetLiveStockQuantity
<?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>
<GetLiveStockQuantity>
<StockCodeToGet>value</StockCodeToGet>
</GetLiveStockQuantity>
</soap:Body>
</soap:Envelope>
Host: cpslive.co.uk
Accept: application/xml
Content-Type: text/xml
Content-Length: length
SOAPAction: https://cpslive.co.uk/GetLiveStockQuantity
<?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>
<GetLiveStockQuantity>
<StockCodeToGet>value</StockCodeToGet>
</GetLiveStockQuantity>
</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>
<GetLiveStockQuantity_response>
<StockCode>value</StockCode>
<StockDescription>value</StockDescription>
<StockQuantityAvailable>value</StockQuantityAvailable>
<RestockDetails>value</RestockDetails>
</GetLiveStockQuantity_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>
<GetLiveStockQuantity_response>
<StockCode>value</StockCode>
<StockDescription>value</StockDescription>
<StockQuantityAvailable>value</StockQuantityAvailable>
<RestockDetails>value</RestockDetails>
</GetLiveStockQuantity_response>
</soap:Body>
</soap:Envelope>
Example Code - JavaScript
function GetLiveStockQuantity_soap11(host,xmldata,result){
fetch(host + "/Livesync", {
method: "POST",
credentials: "include",
headers: {
"Content-Type": "text/xml; charset=utf-8",
"Accept": "application/xml;",
"SOAPAction": host + "/GetLiveStockQuantity",
},
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: {
"Content-Type": "text/xml; charset=utf-8",
"Accept": "application/xml;",
"SOAPAction": host + "/GetLiveStockQuantity",
},
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 --header "Content-Type: text/xml; ; charset=utf-8" --header "Accept: application/xml" --header "SOAPAction: cpslive.co.uk/GetLiveStockQuantity" --data-binary @xmlDataFile.xml https://cpslive.co.uk/Livesync
Try It - Live
xmldata
result
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.
Example Request
POST /Livesync HTTP/1.1
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>
<GetLiveStockQuantity>
<StockCodeToGet>value</StockCodeToGet>
</GetLiveStockQuantity>
</soap:Body>
</soap:Envelope>
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>
<GetLiveStockQuantity>
<StockCodeToGet>value</StockCodeToGet>
</GetLiveStockQuantity>
</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>
<GetLiveStockQuantity_response>
<StockCode>value</StockCode>
<StockDescription>value</StockDescription>
<StockQuantityAvailable>value</StockQuantityAvailable>
<RestockDetails>value</RestockDetails>
</GetLiveStockQuantity_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>
<GetLiveStockQuantity_response>
<StockCode>value</StockCode>
<StockDescription>value</StockDescription>
<StockQuantityAvailable>value</StockQuantityAvailable>
<RestockDetails>value</RestockDetails>
</GetLiveStockQuantity_response>
</soap:Body>
</soap:Envelope>
Example Code - JavaScript
function GetLiveStockQuantity_soap12(host,xmldata,result){
fetch(host + "/Livesync", {
method: "POST",
credentials: "include",
headers: {
"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: {
"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 --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
xmldata
result
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 /GetLiveStockQuantity HTTP/1.1
Host: cpslive.co.uk
Accept: application/xml
Content-Type: application/x-www-form-urlencoded
Content-Length: length
StockCodeToGet=value
Host: cpslive.co.uk
Accept: application/xml
Content-Type: application/x-www-form-urlencoded
Content-Length: length
StockCodeToGet=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"?>
<GetLiveStockQuantity_response>
<StockCode>value</StockCode>
<StockDescription>value</StockDescription>
<StockQuantityAvailable>value</StockQuantityAvailable>
<RestockDetails>value</RestockDetails>
</GetLiveStockQuantity_response>
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<GetLiveStockQuantity_response>
<StockCode>value</StockCode>
<StockDescription>value</StockDescription>
<StockQuantityAvailable>value</StockQuantityAvailable>
<RestockDetails>value</RestockDetails>
</GetLiveStockQuantity_response>
Example Code - JavaScript
function GetLiveStockQuantity_post(host,postdata,result){
fetch(host + "/GetLiveStockQuantity", {
method: "POST",
credentials: "include",
headers: {
"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 + "/GetLiveStockQuantity", {
method: "POST",
credentials: "include",
headers: {
"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 --header "Content-Type: application/x-www-form-urlencoded; charset=utf-8" --header "Accept: application/xml" --data "StockCodeToGet=value" https://cpslive.co.uk/GetLiveStockQuantity
Try It - Live
StockCodeToGet
result
(c) 2024 by CPS Partnership Ltd. All rights reserved