POST api/v1/ProductAttribFilter
Retrieve the list of product attributes and filters.
Request Information
URI Parameters
None.
Body Parameters
ParamsName | Description | Type | Additional information |
---|---|---|---|
apiKey |
Please contact Caliq support to get your key |
string |
Required Max length: 30 |
Request Formats
application/json, text/json
Sample:
{ "apiKey": "sample string 1" }
application/xml, text/xml
Sample:
<Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <apiKey>sample string 1</apiKey> </Params>
Response Information
Resource Description
Returns:
200 OK Returns a list of all the attributes and filters which can be assigned to products
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if there are no matching records in Caliq
503 Service Unavailable
Name | Description | Type | Additional information |
---|---|---|---|
ProductAttribFilter | Collection of VarAttrib |
None. |
Response Formats
application/json, text/json
Sample:
{ "ProductAttribFilter": [ { "Kind": "sample string 1", "Slot": 2, "Name": "sample string 3", "VarAttribVs": [ { "Description": "sample string 1" }, { "Description": "sample string 1" } ] }, { "Kind": "sample string 1", "Slot": 2, "Name": "sample string 3", "VarAttribVs": [ { "Description": "sample string 1" }, { "Description": "sample string 1" } ] } ] }
application/xml, text/xml
Sample:
<ProductVarsAttribs xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <VarAttrib> <Kind>sample string 1</Kind> <Slot>2</Slot> <Name>sample string 3</Name> <VarAttribVs> <VarAttribV> <Description>sample string 1</Description> </VarAttribV> <VarAttribV> <Description>sample string 1</Description> </VarAttribV> </VarAttribVs> </VarAttrib> <VarAttrib> <Kind>sample string 1</Kind> <Slot>2</Slot> <Name>sample string 3</Name> <VarAttribVs> <VarAttribV> <Description>sample string 1</Description> </VarAttribV> <VarAttribV> <Description>sample string 1</Description> </VarAttribV> </VarAttribVs> </VarAttrib> </ProductVarsAttribs>