getCategoryAttributes

Method returns list of category attributes.

Usage URL: https://magboss.pl/api/getCategoryAttributes.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

id
integer or integer[]
Internal identifier of category attribute.
More than one value can be specified after comma (,) separator.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of category attribute.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
categoryid
integer or integer[]
Internal identifier of category.
More than one value can be specified after comma (,) separator.
{"name":"categoryid","propertyName":"categoryId","type":{"format":null},"description":"Internal identifier of category.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
name
string
Name of category attribute.
Example: 'cover' will return all category attributes that contain cover in the name.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of category attribute.","example":"'cover' will return all category attributes that contain cover<\/strong> in the name.","required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Return all category attributes modified after the modified param. That is highly recommended when you want to update your local database.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all category attributes modified after the modified<\/strong> param. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
type
string
Return all category attributes with that type.
Example: Supported types: mru, float, int, text, date
{"name":"type","propertyName":"type","type":{"format":null},"description":"Return all category attributes with that type.","example":"Supported types: mru, float, int, text, date","required":false,"children":[]}
lang
string
Language of result. ISO 2 Letter Language Codes ie
Example: en, pl, cs
{"name":"lang","propertyName":"lang","type":{"format":null},"description":"Language of result. ISO 2 Letter Language Codes ie","example":"en, pl, cs","required":false,"children":[]}

id
integer
Internal identifier of category attribute.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of category attribute.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Category attributes modified after the modified date.
Date format is yyyy-MM-dd.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Category attributes modified after the modified<\/strong> date. Date format is yyyy-MM-dd.","example":null,"required":false,"children":[]}
name
string
Name of category attribute.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of category attribute.","example":null,"required":false,"children":[]}
description
string
Description of category attribute.
{"name":"description","propertyName":"description","type":{"format":null},"description":"Description of category attribute.","example":null,"required":false,"children":[]}
type
string
Category attributes with that type. Supported types: mru, float, int, text, date
{"name":"type","propertyName":"type","type":{"format":null},"description":"Category attributes with that type. Supported types:<\/strong> mru, float, int, text, date","example":null,"required":false,"children":[]}
categoryids
integer[]
Internal identifiers of categories that attribute is used in.
{"name":"categoryids","propertyName":"categoryIds","type":{"format":null},"description":"Internal identifiers of categories that attribute is used in.","example":null,"required":false,"children":[]}
varianttype
integer
0 - regular attribute, 1 - attribute can be used to group products into variants, 2 - variants with pictures.
{"name":"varianttype","propertyName":"variantType","type":{"format":null},"description":"0 - regular attribute, 1 - attribute can be used to group products into variants, 2 - variants with pictures.","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getCategoryAttributes.json?key=YOURAPIKEY&lang=en&categoryid=2662

[
    {
        "id": 9,
        "modified": "2016-11-30 02:20:27",
        "name": "Phone Manufacturer",
        "description": null,
        "type": "mru",
        "fkcategory": 2662
    },
    {
        "id": 6,
        "modified": "2016-11-30 08:46:12",
        "name": "Accessory Manufacturer",
        "description": null,
        "type": "mru",
        "fkcategory": 2622
    }
]

Example URL: https://magboss.pl/api/getCategoryAttributes.xml?key=YOURAPIKEY&lang=en&categoryid=2662

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<id>9</id>
		<modified>2016-11-30 02:20:27</modified>
		<name>Phone Manufacturer</name>
		<description></description>
		<type>mru</type>
		<fkcategory>2662</fkcategory>
	</item>
	<item>
		<id>6</id>
		<modified>2016-11-30 08:46:12</modified>
		<name>Accessory Manufacturer</name>
		<description></description>
		<type>mru</type>
		<fkcategory>2622</fkcategory>
	</item>
</root>