getProductCategories

Method returns product categories

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

Query params

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

id
integer or integer[]
Internal identifier of product category.
More than one value can be specified after comma (,) separator.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of product category.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
name
string
Name of the category.
Example: 'electronic devices' will return all products categories types that contain electronic devices in the `name` field.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of the category.","example":"'electronic devices' will return all products categories types that contain electronic devices<\/strong> in the `name` field.","required":false,"children":[]}
fkparent
integer
Identifier of parent category. If you specify one, method return only one level of categories. Value zero (0) = root category.
{"name":"fkparent","propertyName":"fkParent","type":{"format":null},"description":"Identifier of parent category. If you specify one, method return only one level of categories. Value zero (0) = root category.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Return all product categories 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 product categories modified after the modified<\/strong> param. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
adult
boolean (1 = true, 0 = false)
Returns only products categories that are recommended for adults only.
Example: If set to true - only adult content will be returned, if set to false - only non-adult content will be returned.
{"name":"adult","propertyName":"adult","type":{"format":"1 = true, 0 = false"},"description":"Returns only products categories that are recommended for adults only.","example":"If set to true<\/strong> - only adult content will be returned, if set to false<\/strong> - only non-adult content will be returned.","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 product category.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of product category.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
When last modified.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When last modified.","example":null,"required":false,"children":[]}
name
string
Name of category
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of category","example":null,"required":false,"children":[]}
description
string
Description of category
{"name":"description","propertyName":"description","type":{"format":null},"description":"Description of category","example":null,"required":false,"children":[]}
fkparent
integer
Identifier of parent category. Zero '0' is root category.
{"name":"fkparent","propertyName":"fkParent","type":{"format":null},"description":"Identifier of parent category. Zero '0' is root category.","example":null,"required":false,"children":[]}
order
integer
Order of category
{"name":"order","propertyName":"order","type":{"format":null},"description":"Order of category","example":null,"required":false,"children":[]}
countpublished
integer
Count of all published products in this category
{"name":"countpublished","propertyName":"countPublished","type":{"format":null},"description":"Count of all published products in this category","example":null,"required":false,"children":[]}
foradults
boolean (1 = true, 0 = false)
Content recommended for adults only
{"name":"foradults","propertyName":"forAdults","type":{"format":"1 = true, 0 = false"},"description":"Content recommended for adults only","example":null,"required":false,"children":[]}

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

[
    {
        "id": 2662,
        "modified": "2016-11-30 02:30:21",
        "name": "Films \/ Security glasses",
        "description": null,
        "fkparent": 2622,
        "order": 0,
        "countpublished": 39
    }
]

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

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<id>2662</id>
		<modified>2016-11-30 02:30:21</modified>
		<name>Films / Security glasses</name>
		<description></description>
		<fkparent>2622</fkparent>
		<order>0</order>
		<countpublished>39</countpublished>
	</item>
</root>