shop.category.update

Обновляет информацию о категории товаров.

HTTP-метод

POST

Формат запроса

application/x-www-form-urlencoded

Параметры

  • id GET
    ID категории.
  • parent_id POST Необязательно
    ID родительской категории. Если не указано, то используется значение по умолчанию 0.
  • depth POST Необязательно
    Уровень вложенности в иерархии категорий.
  • meta_title POST Необязательно
    Элемент TITLE страницы категории.
  • meta_keywords POST Необязательно
    Содержимое атрибута META keywords.
  • meta_description POST Необязательно
    Содержимое атрибута META description.
  • url POST Необязательно
    Ссылка на витрину.
  • description POST Необязательно
    Описание.
  • conditions POST Необязательно
    Строка с условиями подбора товаров для динамической категории, в которой параметры разделены символом &.

    Примеры параметров:
    • create_datetime>=2022-10-13 начало периода для проверки даты создания товара;
    • create_datetime<=2022-10-15 конец периода для проверки даты создания товара;
    • price>=100 начало диапазона для проверки цены товара;
    • price<=200 конец диапазона для проверки цены товара;
    • compare_price>=200 начало диапазона для проверки зачёркнутой цены товара;
    • compare_price<=300 конец диапазона для проверки зачёркнутой цены товара;
    • purchase_price>=50 начало диапазона для проверки закупочной цены товара;
    • purchase_price<=70 конец диапазона для проверки закупочной цены товара;
    • edit_datetime>=2022-10-01 начало периода для проверки даты последнего редактирования товара;
    • edit_datetime<=2022-10-10 конец периода для проверки даты последнего редактирования товара;
    • rating>=3 начало диапазона для проверки рейтинга товара;
    • rating<=5 конец диапазона для проверки рейтинга товара;
    • type=14||13 ID типов товаров;
    • count>=5 начало диапазона для проверки количества товара на складе;
    • count<=100 конец диапазона для проверки количества товара на складе;
    • badge=lowprice||bestseller идентификаторы наклеек товара;
    • brand.value_id=159,190 ID значений характеристики с идентификатором 'brand'.
  • filter POST Необязательно
    Параметры настроек для фильтра товаров на витрине — в виде строки с идентификаторами полей фильтра, разделёнными запятой. Идентификаторами полей могут быть числовые ID характеристик товаров и строка 'price' — для обозначения фильтра по цене. Порядок сортировки идентификаторов в этой строке соответствует порядку сортировки полей фильтра.
  • sort_products POST Необязательно
    Правило сортировки товаров по умолчанию, составленное из имени одного из полей со свойствами товаров и обозначения направления сортировки, разделённых пробелом. Например: 'name ASC', 'price DESC'.

    Список доступных имён полей для сортировки товаров:
    • name ASC по наименованию,
    • price DESC самые дорогие,
    • price ASC самые дешевые,
    • rating DESC с высокой оценкой,
    • rating ASC с низкой оценкой,
    • total_sales DESC хиты по сумме продаж,
    • total_sales ASC низкие продажи,
    • count DESC в наличии,
    • create_datetime DESC дата добавления,
    • stock_worth DESC стоимость активов после реализации.
    Пустое значение соответствует сортировке товаров, заданной вручную в панели управления магазина, — только для статических категорий.
  • include_sub_categories POST Необязательно
    Флаг (0 или 1), обозначающий необходимость отображения товаров из подкатегорий данной категории.
  • status POST Необязательно
    Статус категории: 0 — скрытая, 1 — доступная на витрине.
  • 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 — видимая.