Product
Interface
It allows you:
to get the public products catalogue with information about product and current price list You can acces only products with 'IsSelfService' checkbox marked (Y)
Prerequisites:
in order to use this API Method you must have an active Web Store registered in SocrateCloud!
Columns that can be used as filters:
WebContext (mandatory) - Web Store's web context
Value
Name
UPC_SKU
ProductCategory
ProductSubCategory
FamilyType
ProductFamily
IsWebStoreFeatured
HasStock
Active
Tax
LastModified (UTC time format ISO 8601: yyyy-MM-dd HH:mm:ss Z, max date from Product, Price, Inventory). The sign used for comparison is ”>” (exclusive). Use this filter to get all the product/price/inventory modified after the date/time value sent in this parameter. (for e g: LastModified=2014-06-13 12:40:00 +0300 if you are in Romania or: LastModified=2014-06-13%2012:40:00%20%2b0300)
AttributeSet
Attribute
AttributeValue
AttributeValueList
Actions can be done:
list
API Methods:
List:
URL: https://api.socratecloud.com/webapi/rest/public/wstore/product/list/{version}?startRow={0}&endRow={100}&WebContext={web_context}
Method: GET
Available filter parameters:
WebContext (mandatory) - Web Store's web context
Value
Name
UPC_SKU
ProductCategory
ProductSubCategory
FamilyType
ProductFamily
IsWebStoreFeatured
HasStock
Active
Tax
LastModified (UTC time format ISO 8601: yyyy-MM-dd HH:mm:ss Z, max date from Product, Price, Inventory). Use this filter to get the newest product, inventory, selling price since last interrogation (for e g: LastModified=2014-06-13 12:40:00 +0300 if you are in Romania or: LastModified=2014-06-13%2012:40:00%20%2b0300)
AttributeSet
Attribute
AttributeValue
AttributeValueList
The value of this parameter should be provided in the format of a JSON object whose field names are the attribute names on which to filter and the values of the fields are the attribute values on which to filter. If for an attribute it is wanted to filter for many values of the attribute the value of the field should be provided in the form of a JSON array.
Ex.
{
"attribute_name1":"attribute_value1", --> single attribute value
"attribute_name2":"attribute_value2", --> single attribute value
"attribute_name3":["attribute_value3","attribute_value4","attribute_value5"] --> multiple attribute values
}
The filter is applied with logical AND between the values of different attributes and with logical OR between the values of the same attribute.
Ex. For the example above JSON will translate to the following filter
attribute_name1=attribute_value1 AND attribute_name2=attribute_value2 AND (attribute_name3=attribute_value3 OR attribute_name3=attribute_value4 OR attribute_name3=attribute_value5)
Return: JSON object with next format:
{
"data": [
{
"Created": "2014-04-25 13:00:08",
"Updated": "2007-08-22 08:30:19",
"Value": "9781405915571",
"Name": "The One Plus One",
"Description": null,
"Help": null,
"UPC": null,
"SKU": null,
"Active": true,
"UOM": "Each",
"TaxCategory": "TVA 24%",
"ProductCategory": "English Book",
"ProductSubcategory": null,
"ProductFamily": null,
"FamilyType": null,
"ProductType": "Item",
"NetWeight": 0,
"Volume": 0,
"QtyOnHand": 0,
"QtyAvailable": 0,
"HasStock": true,
"Currency": "RON",
"IsTaxIncluded": true,
"ListPrice": 0,
"StdPrice": "100",
"Tax": "24% ",
"TaxRate": 24,
"AttributeSet": "Gust si culoare",
"attributes": {
"Width": 10,
"Height": 25
}
}
],
"totalRows": 1
}
Get picture:
URL: https://api.socratecloud.com/webapi/rest/public/wstore/product/picture/{version}?startRow={0}&endRow={100}&WebContext={web_context}&Value={product_value}
Method: GET
Available parameters:
WebContext (mandatory) - Web Store's web context
Value (mandatory) - product code
FileName - picture file name to get. If not specified the filename will default to picture.png
Return: File or 204/"No Content" if no picture found
List picture:
URL: https://api.socratecloud.com/webapi/rest/public/wstore/product/picture/list/{version}?WebContext={web_context}&Value={product_value}
Method: GET
Available parameters:
WebContext (mandatory) - Web Store's web context
Value (mandatory) - product code
Return: JSON with the following format:
{
"data": [
{
"FileName": "20x20.gif",
"Length": 784
},
{
"FileName": "800x600.jpg",
"Length": 7767
}
],
"totalRows": 2
}