API method

getProductCategories

Method returns product categories

GET
Usage URL
https://b2b.onesto-energy.pl/api/getProductCategories.json?key=YOURAPIKEY

Query params

Put these 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 string

    Name of the category.

    Example

    'electronic devices' will return all products categories types that contain electronic devices in the `name` field.

  • fkparent integer

    Identifier of parent category. If you specify one, method return only one level of categories. Value zero (0) = root category.

  • 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.

  • 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.

  • lang string

    Language of result. ISO 2 Letter Language Codes

    Example

    en, pl, cs

Response fields

Fields returned by this method.

  • id integer

    Internal identifier of product category.

  • modified datetime YYYY-MM-DD HH:MM:SS

    When last modified.

  • name string

    Name of category

  • description string

    Description of category

  • fkparent integer

    Identifier of parent category. Zero '0' is root category.

  • order integer

    Order of category

  • countpublished integer

    Count of all published products in this category

  • foradults boolean 1 = true, 0 = false

    Content recommended for adults only

Response JSON 
Example URL: https://b2b.onesto-energy.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
    }
]
Response XML 
Example URL: https://b2b.onesto-energy.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>