API Reference

Get CategoryTree

Retrieves a list with existing categories on catalog.
The pagination fields: perPage and page are required.

This action returns a list of categories and their children if includeChildren parameter is defined as true.

Fields retrieved:

FieldTypeDescription
pageIntPage number.
perPageIntNumber of categories per page.
maxCountIntTotal of categories.
sortFieldIntFields filter.
sortAscendingBooleanOrder by ascending (true) or descending (false).
maxPageIntMax number of pages.
categoriesString ArrayCategories list.
parentIdGuidID of category parent.
nameStringCategory name.
codeStringCategory code.
orderIntCategory order.
urlStringCategory address.
iconUrlStringCategory icon address.
imageUrlStringCategory image address.
hexColorHexadecimalCategory color.
descriptionStringCategory description.
childrenString ArrayChildren categories of a category.
Language
Credentials
Basic
base64
:
URL