shop.category.getTree

Возвращает дерево категорий товаров.

Параметры

  • parent_id GET

    ID категории, которая должна считаться корнем дерева.

  • depth GET Необязательно

    Количество уровней дерева, которые необходимо получить. Если не указано, то метод возвращает всё дерево категорий.

  • access_token GET

    Токен авторизации, полученный при подключении к API.

  • format GET Необязательно

    Устанавливает формат ответа. Возможные значения: json (по умолчанию), xml.

Массив информации со списком категорий товаров. Подмассив каждой категории содержит следующие значения:

  • []['id'] int ID категории.
  • []['depth'] int Уровень вложенности категории в дереве категорий начиная с 0.
  • []['parent_id'] int ID родительской категории или 0, если у категории нет родительской.
  • []['name'] string Наименование категории.
  • []['meta_title'] string Значение тега <TITLE>.
  • []['meta_keywords'] string Значение метатега keywords.
  • []['meta_description'] string Значение метатега description.
  • []['type'] int Обозначение типа категории: 0 — статическая, 1 — динамическая.
  • []['url'] string Редактируемая часть URL категории на витрине магазина.
  • []['full_url'] string Относительный URL категории с учётом URL родительских категорий.
  • []['count'] int Количество товаров, для которых данная статическая категория является основной. Не используется для динамических категорий.
  • []['description'] string Описание категории.
  • []['conditions'] string Описание условий для формирования списка товаров в динамической категории. Не используется для статических категорий.
  • []['create_datetime'] datetime Дата и время создания категории.
  • []['edit_datetime'] datetime Дата и время последнего редактирования категории.
  • []['filter'] string Информация о настройках фильтра товаров в категории в виде идентификаторов полей фильтра, разделённых запятой. Идентификаторами полей могут числовые ID характеристик товаров и строка 'price' для обозначения фильтра по цене. Порядок сортировки идентификаторов в этой строке соответствует порядку сортировки полей фильтра.
  • []['sort_products'] string Правило сортировки товаров в категории по умолчанию.
  • []['include_sub_categories'] int Флаг, обозначающий, должны ли в категории отображаться товары из её подкатегорий: 0 — не должны, 1 — должны.
  • []['status'] int Статус видимости категории: 0 — скрытая, 1 — видимая.

Пример

https://demo1-ru.webasyst.com/api.php/shop.category.getTree?