Добавить раздел торгового каталога catalog.section.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: администратор
Метод catalog.section.add добавляет раздел торгового каталога.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для создания нового раздела каталога |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
iblockId* |
Идентификатор инфоблока. Для получения существующих идентификаторов необходимо использовать catalog.catalog.list |
|
iblockSectionId |
Идентификатор родительского раздела. Для получения существующих идентификаторов необходимо использовать catalog.section.list. По умолчанию выбирается верхний уровень |
|
name* |
Название раздела каталога |
|
xmlId |
Внешний идентификатор. Можно использовать для синхронизации текущего раздела каталога с аналогичной позицией во внешней системе |
|
code |
Код раздела каталога. Должен быть уникальным |
|
sort |
Сортировка. По умолчанию 500 |
|
active |
Индикатор активности раздела каталога:
По умолчанию |
|
description |
Описание |
|
descriptionType |
Тип описания. Доступные типы: |
Примеры кода
Как использовать примеры в документации
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"name": "Детские игрушки",
"iblockId": 14,
"iblockSectionId": 13,
"sort": "100",
"active": "Y",
"code": "toys",
"xmlId": "myXmlId",
"description": "Товары для детей - игрушки",
"descriptionType": "text"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.add
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"name": "Детские игрушки",
"iblockId": 14,
"iblockSectionId": 13,
"sort": "100",
"active": "Y",
"code": "toys",
"xmlId": "myXmlId",
"description": "Товары для детей - игрушки",
"descriptionType": "text"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/catalog.section.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SectionAddResult = {
section: {
active: string
code: string
description: string
descriptionType: string
iblockId: number
iblockSectionId: number
id: number
name: string
sort: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<SectionAddResult>({
method: 'catalog.section.add',
params: {
fields: {
name: "Kids Toys",
iblockId: 14,
iblockSectionId: 13,
sort: '100',
active: 'Y',
code: 'toys',
xmlId: 'myXmlId',
description: "Products for children - toys",
descriptionType: "text",
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.section.id, result.section.name)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addCatalogSection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.section.add',
params: {
fields: {
name: "Kids Toys",
iblockId: 14,
iblockSectionId: 13,
sort: '100',
active: 'Y',
code: 'toys',
xmlId: 'myXmlId',
description: "Products for children - toys",
descriptionType: "text",
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.section.id, result.section.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCatalogSection)
</script>
try {
$response = $b24Service
->core
->call(
'catalog.section.add',
[
'fields' => [
'name' => 'Детские игрушки',
'iblockId' => 14,
'iblockSectionId' => 13,
'sort' => '100',
'active' => 'Y',
'code' => 'toys',
'xmlId' => 'myXmlId',
'description' => "Товары для детей - игрушки",
'descriptionType' => "text",
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding catalog section: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.section.add',
{
fields: {
name: 'Детские игрушки',
iblockId: 14,
iblockSectionId: 13,
sort: '100',
active: 'Y',
code: 'toys',
xmlId: 'myXmlId',
description: "Товары для детей - игрушки",
descriptionType: "text"
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.section.add',
[
'fields' => [
'name' => 'Детские игрушки',
'iblockId' => 14,
'iblockSectionId' => 13,
'sort' => '100',
'active' => 'Y',
'code' => 'toys',
'xmlId' => 'myXmlId',
'description' => 'Товары для детей - игрушки',
'descriptionType' => 'text'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"section": {
"active": "Y",
"code": "toys",
"description": "Товары для детей - игрушки",
"descriptionType": "text",
"iblockId": 14,
"iblockSectionId": 13,
"id": 31,
"name": "Детские игрушки",
"sort": 100,
"xmlId": "myXmlId"
}
},
"time": {
"start": 1716552521.40908,
"finish": 1716552521.69852,
"duration": 0.289434909820557,
"processing": 0.011207103729248,
"date_start": "2024-05-24T14:08:41+02:00",
"date_finish": "2024-05-24T14:08:41+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
section |
Объект с информацией о добавленном разделе каталога |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300040,
"error_description":"Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Нет доступа к редактированию |
|
|
Ошибки при добавлении, например, идентификатор инфоблока создаваемого раздела не совпадает с идентификатором инфоблока раздела-родителя |
|
|
Нарушение уникальности поля |
|
|
Инфоблока с заданным |
|
|
Не передан обязательный параметр |
|
|
Не установлены обязательные поля |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить раздел торгового каталога catalog.section.update
- Получить значения полей раздела торгового каталога catalog.section.get
- Получить список разделов торгового каталога catalog.section.list
- Удалить раздел торгового каталога catalog.section.delete
- Получить поля раздела торгового каталога catalog.section.getFields