Обновить раздел

PATCH /v1/product-sections/:id

Обновляет существующий раздел каталога товаров. В теле передаются только изменяемые поля. Поля передаются плоско в корне JSON, без обёртки fields.

Параметры

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

Поля запроса (body)

Поле Битрикс24 Тип Обяз. Описание
name NAME string нет Название раздела
catalogId CATALOG_ID number нет Идентификатор каталога. Список: GET /v1/catalogs
sectionId SECTION_ID number нет Идентификатор родительского раздела для вложенности. У раздела верхнего уровня — null
code CODE string нет Символьный код раздела
xmlId XML_ID string нет Внешний идентификатор
sort SORT number нет Индекс сортировки
id ID number RO Идентификатор раздела. Заполняется системой

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/product-sections/197" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Верхняя одежда"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/product-sections/197" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Верхняя одежда"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/product-sections/197', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Верхняя одежда',
  }),
})

const { success, data } = await res.json()
console.log('Обновлённое название:', data.name)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/product-sections/197', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Верхняя одежда',
  }),
})

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

Поля ответа

Возвращается полный объект раздела после обновления.

Поле Тип Описание
id number Идентификатор раздела
name string Название раздела
catalogId number Идентификатор каталога
sectionId number Идентификатор родительского раздела или null
xmlId string Внешний идентификатор или null
code string Символьный код раздела

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

JSON 
{
  "success": true,
  "data": {
    "id": 197,
    "name": "Верхняя одежда",
    "catalogId": 25,
    "sectionId": null,
    "xmlId": null,
    "code": "odezhda"
  }
}

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

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

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

Ошибки

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

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

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