Получить раздел

GET /v1/catalog-sections/:id

Возвращает один раздел каталога по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор раздела

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-sections/31" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-sections/31" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-sections/31', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Раздел:', data.name)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-sections/31', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор раздела
data.iblockId number ID каталога, которому принадлежит раздел
data.iblockSectionId number | null ID родительского раздела. null — раздел верхнего уровня
data.name string Название раздела
data.code string | null Символьный код раздела
data.xmlId string | null Внешний идентификатор
data.sort number Индекс сортировки
data.active boolean Активен ли раздел
data.description string | null Описание раздела
data.descriptionType string Формат описания: text или html

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "active": true,
    "code": "clothes",
    "description": null,
    "descriptionType": "text",
    "iblockId": 25,
    "iblockSectionId": null,
    "id": 31,
    "name": "Одежда",
    "sort": 50,
    "xmlId": null
  }
}

Пример ответа при ошибке

422 — раздела с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Access Denied"
  }
}

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Раздела с указанным id не существует или нет доступа — Битрикс24 отвечает Access Denied
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Смотрите также