Web Service API


Click here for a complete list of operations.

GetStockQuantities_InBatchesOf500_XML

Returns all available stock into an XML Format in batches of 500 products.

If you wish to retrieve all products in one go, use the light version.
To retrieve specific codes only, fill in the FilterCodeLike parameter
and this will get you only the product code that start with the specified character sequence.
If you want to filter by product name/description, fill in the FilterDescriptionLike parameter
and you will get only products containing the specified string.
Example: Batch 1, Code: 225, Description Hawaii. This will return all codes that start with 255*
and contain hawaii in the description. As a recommendation, use Batch 1 when filtering data because the result set
is usually less then 500 products

Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
batchNumber: The batch number, batch number 1 return the first 500 result, batch 2 return the next 500.
if there is less than 500 results, requesting batch number 2 will return nothing.
filterCode: A Partial or Full Product Code to filter the data on
filterDescription: A Partial or Full Product Description to filter the data on
LanguageCode: The two letter language code e.g. EN

Returns:
All available stock into an XML Format in batches of 500 products.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
apiKey:
clientID:
batchNumber:
filterCode:
filterDescription:
LanguageCode:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /services/products.asmx HTTP/1.1
Host: webservices.smiffys.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://smiffys.com/GetStockQuantities_InBatchesOf500_XML"

<?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>
    <GetStockQuantities_InBatchesOf500_XML xmlns="http://smiffys.com/">
      <apiKey>string</apiKey>
      <clientID>string</clientID>
      <batchNumber>string</batchNumber>
      <filterCode>string</filterCode>
      <filterDescription>string</filterDescription>
      <LanguageCode>string</LanguageCode>
    </GetStockQuantities_InBatchesOf500_XML>
  </soap:Body>
</soap:Envelope>
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>
    <GetStockQuantities_InBatchesOf500_XMLResponse xmlns="http://smiffys.com/">
      <GetStockQuantities_InBatchesOf500_XMLResult>xml</GetStockQuantities_InBatchesOf500_XMLResult>
    </GetStockQuantities_InBatchesOf500_XMLResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /services/products.asmx HTTP/1.1
Host: webservices.smiffys.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetStockQuantities_InBatchesOf500_XML xmlns="http://smiffys.com/">
      <apiKey>string</apiKey>
      <clientID>string</clientID>
      <batchNumber>string</batchNumber>
      <filterCode>string</filterCode>
      <filterDescription>string</filterDescription>
      <LanguageCode>string</LanguageCode>
    </GetStockQuantities_InBatchesOf500_XML>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetStockQuantities_InBatchesOf500_XMLResponse xmlns="http://smiffys.com/">
      <GetStockQuantities_InBatchesOf500_XMLResult>xml</GetStockQuantities_InBatchesOf500_XMLResult>
    </GetStockQuantities_InBatchesOf500_XMLResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /services/products.asmx/GetStockQuantities_InBatchesOf500_XML?apiKey=string&clientID=string&batchNumber=string&filterCode=string&filterDescription=string&LanguageCode=string HTTP/1.1
Host: webservices.smiffys.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0"?>
xml

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /services/products.asmx/GetStockQuantities_InBatchesOf500_XML HTTP/1.1
Host: webservices.smiffys.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apiKey=string&clientID=string&batchNumber=string&filterCode=string&filterDescription=string&LanguageCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0"?>
xml