Изменить раздел торгового каталога catalog.section.update

Scope: catalog

Кто может выполнять метод: администратор

Метод catalog.section.update изменяет раздел торгового каталога.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
id* `catalog_section.id`	Идентификатор раздела каталога
fields* `object`	Значения полей для обновления раздела каталога

Параметр fields

Обязательные параметры отмечены *

Название `тип`	Описание
iblockId* `catalog_catalog.id`	Идентификатор инфоблока. Для получения существующих идентификаторов необходимо использовать catalog.catalog.list
iblockSectionId `catalog_section.id`	Идентификатор родительского раздела. Для получения существующих идентификаторов необходимо использовать catalog.section.list
name* `string`	Название раздела каталога
xmlId `string`	Внешний идентификатор. Можно использовать для синхронизации текущего раздела каталога с аналогичной позицией во внешней системе
code `string`	Код раздела каталога. Должен быть уникальным
sort `integer`	Сортировка
active `string`	Индикатор активности раздела каталога: `Y` — активен `N` — неактивен
description `string`	Описание раздела каталога
descriptionType `string`	Тип описания. Доступные типы: `text`, `html`

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "id": 32,
            "fields": {
                "iblockId": 14,
                "name": "Детские игрушки",
                "description": "<H1>Детские игрушки</H1> <p>Товары для детей</p>",
                "descriptionType": "html"
            }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.update

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "id": 32,
            "fields": {
                "iblockId": 14,
                "name": "Детские игрушки",
                "description": "<H1>Детские игрушки</H1> <p>Товары для детей</p>",
                "descriptionType": "html"
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/catalog.section.update

try
        {
        	const response = await $b24.callMethod(
        		'catalog.section.update', 
        		{
        			id: 32,
        			fields: {
        				iblockId: 14,
        				name: 'Детские игрушки',
        				description: "<H1>Детские игрушки</H1> <p>Товары для детей</p>",
        				descriptionType: "html"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.section.update',
                    [
                        'id' => 32,
                        'fields' => [
                            'iblockId'        => 14,
                            'name'            => 'Детские игрушки',
                            'description'     => "<H1>Детские игрушки</H1> <p>Товары для детей</p>",
                            'descriptionType' => "html",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating catalog section: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.section.update', 
            {
                id: 32,
                fields: {
                    iblockId: 14,
                    name: 'Детские игрушки',
                    description: "<H1>Детские игрушки</H1> <p>Товары для детей</p>",
                    descriptionType: "html"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.section.update',
            [
                'id' => 32,
                'fields' => [
                    'iblockId' => 14,
                    'name' => 'Детские игрушки',
                    'description' => '<H1>Детские игрушки</H1> <p>Товары для детей</p>',
                    'descriptionType' => 'html'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

    {
            "result": {
                "section": {
                "active": "Y",
                "code": "toys1",
                "description": "<H1>Детские игрушки</H1> <p>Товары для детей</p>",
                "descriptionType": "html",
                "iblockId": 14,
                "iblockSectionId": 13,
                "id": 32,
                "name": "Детские игрушки",
                "sort": 100,
                "xmlId": "myXmlId"
            }
            },
            "time": {
                "start": 1712327086.69665,
                "finish": 1712327086.95303,
                "duration": 0.256376028060913,
                "processing": 0.0112268924713135,
                "date_start": "2024-04-05T16:24:46+02:00",
                "date_finish": "2024-04-05T16:24:46+02:00",
                "operating": 0
            }
            }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа
section `catalog_section`	Объект с информацией об обновленном разделе каталога
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error":0,
            "error_description":"Required fields: name"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`200040300040`	Нет доступа к редактированию
`200700300010`	Ошибки при обновлении, например, идентификатор инфоблока обновляемого раздела не совпадает с идентификатором инфоблока раздела-родителя
`200700300030`	Раздела каталога с таким идентификатором не существует
`200700300040`	Нарушение уникальности поля `code`
`200700300050`	Инфоблока с заданным `iblockId` не существует
`100`	Не указан параметр `id`
`100`	Не указан или пустой параметр `fields`
`0`	Не переданы обязательные поля структуры `fields`
`0`	Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Добавить раздел торгового каталога

Получить значения полей раздела торгового каталога

Изменить раздел торгового каталога catalog.section.update

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение