Для AI-агентов: markdown этой страницы — /docs-content/entities/product-sections/get.md индекс документации — /llms.txt

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

GET /v1/product-sections/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор раздела
include (query) string нет Связанные данные: catalog, parentSection. Подробнее — секция «Связанные данные» ниже

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/product-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/product-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/product-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.name string Название раздела
data.catalogId number ID каталога, к которому относится раздел
data.sectionId number ID родительского раздела. У раздела верхнего уровня — null
data.xmlId string Внешний идентификатор
data.code string Символьный код раздела

Связанные данные

Получить связанные записи вместе с разделом — параметр include в GET-запросе:

GET /v1/product-sections/33?include=catalog,parentSection

Доступные include: catalog — торговый каталог, к которому относится раздел, и parentSection — родительский раздел. Связь catalog читает каталоги, поэтому ключу нужен скоуп catalog. У раздела верхнего уровня parentSection приходит null. Результат в поле _included:

JSON 
{
  "success": true,
  "data": {
    "id": 33,
    "name": "Обувь",
    "catalogId": 25,
    "sectionId": 31,
    "_included": {
      "catalog": {
        "id": 25,
        "iblockId": 25,
        "iblockTypeId": "CRM_PRODUCT_CATALOG",
        "name": "Товарный каталог CRM"
      },
      "parentSection": {
        "id": 31,
        "name": "Одежда",
        "catalogId": 25,
        "sectionId": null,
        "code": "clothes"
      }
    }
  }
}

Подробнее об include: Связанные данные.

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

JSON 
{
  "success": true,
  "data": {
    "id": 31,
    "name": "Одежда",
    "catalogId": 25,
    "sectionId": null,
    "xmlId": "666",
    "code": "clothes"
  }
}

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

404 — раздел не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Product section is not found."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Раздела с таким id не существует
400 INVALID_INCLUDE Запрошена связь, которой у раздела нет. Сообщение перечисляет доступные
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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