Для AI-агентов: markdown этой страницы — /docs-content/entities/catalog-services/update.md индекс документации — /llms.txt
Изменить услугу
PATCH /v1/catalog-services/:id
Изменяет существующую услугу каталога. Поля передаются плоско в корне JSON, передавайте только изменяемые — остальные сохраняют текущие значения.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id (path) |
number | да | Идентификатор услуги. Список: GET /v1/catalog-services |
Поля запроса (body)
Основные изменяемые поля — name, active, available, iblockSectionId.
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
name |
string | нет | Название услуги |
active |
boolean | нет | Активна ли услуга |
available |
boolean | нет | Доступна ли услуга к покупке |
iblockSectionId |
number | нет | ID основного раздела каталога. Список: GET /v1/catalog-sections |
iblockSection |
array | нет | Массив ID всех разделов каталога, к которым относится услуга. Список: GET /v1/catalog-sections |
measure |
number | нет | ID единицы измерения. Список: GET /v1/catalog-measures |
vatIncluded |
boolean | нет | НДС включён в цену |
vatId |
number | нет | ID ставки НДС. Список: GET /v1/catalog-vat-rates |
code |
string | нет | Символьный код |
xmlId |
string | нет | Внешний код |
sort |
number | нет | Порядок сортировки |
previewText |
string | нет | Текст анонса |
previewTextType |
string | нет | Формат текста анонса: text или html |
detailText |
string | нет | Подробное описание |
detailTextType |
string | нет | Формат подробного описания: text или html |
previewPicture |
object | нет | Картинка анонса |
detailPicture |
object | нет | Детальная картинка |
propertyNNN |
object | нет | Значение свойства каталога, где NNN — id свойства из GET /v1/catalog-product-properties. Передаётся объектом: "property301": { "value": "A-300" } |
Тело должно содержать хотя бы одно записываемое поле. Пустой PATCH отклоняется с 400 EMPTY_UPDATE_BODY, тело только из неизвестных имён — с 400 NO_RECOGNIZED_UPDATE_FIELDS.
Поле iblockId при изменении не принимается: каталог задаётся при создании. Поля с readonly: true в Полях услуги, например type и createdBy, заполняет система. Любое из этих полей в теле отклоняется с 400 READONLY_FIELD.
Примеры
curl — личный ключ
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-services/7231" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Монтаж кондиционера под ключ"
}'
curl — OAuth-приложение
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-services/7231" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Монтаж кондиционера под ключ"
}'
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-services/7231', {
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-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-services/7231', {
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()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data |
object | Полный объект изменённой услуги. Набор полей — как у GET /v1/catalog-services/:id |
Пример ответа
Показаны основные поля.
{
"success": true,
"data": {
"id": 7231,
"iblockId": 25,
"iblockSectionId": 281,
"iblockSection": [281],
"name": "Монтаж кондиционера под ключ",
"type": 7,
"active": true,
"available": false,
"xmlId": "7231",
"sort": 500,
"measure": 9,
"vatIncluded": true,
"dateCreate": "2026-10-08T20:50:59.000Z",
"timestampX": "2026-10-08T20:52:26.000Z"
}
}
Пример ответа при ошибке
404 — услуги с указанным id нет:
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "service does not exist."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 404 | ENTITY_NOT_FOUND |
Записи с указанным id нет или это не услуга — например, обычный товар каталога (service does not exist.). Запись при этом не меняется |
| 400 | EMPTY_UPDATE_BODY |
Тело запроса пустое — передайте хотя бы одно поле |
| 400 | NESTED_FIELDS_ENVELOPE |
Вместо корневых полей передан объект fields; услуга не обновляется |
| 400 | NO_RECOGNIZED_UPDATE_FIELDS |
В теле нет ни одного распознанного записываемого поля. Сообщение перечисляет допустимые |
| 400 | READONLY_FIELD |
В теле передано поле, которое при изменении не принимается: iblockId или поле только для чтения, например type |
| 403 | SCOPE_DENIED |
Ключу не хватает скоупа catalog |
| 401 | MISSING_API_KEY |
Не передан заголовок X-Api-Key |
Полный список общих ошибок API — Ошибки.
Известные особенности
Свойство каталога меняется только объектом. PATCH со строкой — "property301": "A-200" — или с null отвечает 200, но значение свойства не меняется. Передавайте новое значение объектом { "value": "..." }. При создании услуги строковое свойство принимает и простую строку.
iblockSectionId заменяет все разделы услуги. Если услуга относится к нескольким разделам, PATCH с iblockSectionId оставляет её только в указанном разделе — массив iblockSection в ответе содержит один ID. Чтобы сохранить несколько разделов, передавайте их полным массивом в iblockSection.
Неизвестные скалярные имена рядом с известными пропускаются. Тело с name и неизвестным скалярным именем отвечает 200: name записывается, неизвестное имя отбрасывается без предупреждения. Объект fields отклоняется с 400 NESTED_FIELDS_ENVELOPE до обновления — отправляйте поля услуги в корне JSON.