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

Изменить тип цены

PATCH /v1/catalog-price-types/:id

Частично изменяет тип цены торгового каталога, сохраняя значения полей, которых нет в запросе. Тело запроса плоское, без обёртки fields.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеИдентификатор типа цены, целое неотрицательное число. Список: Список типов цен.

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

Передайте хотя бы одно изменяемое поле.

Поле Тип Обяз. Описание
Полеname Типstring Обяз.нет ОписаниеНазвание типа цены.
Полеsort Типnumber Обяз.нет ОписаниеПорядок сортировки в интерфейсе Битрикс24.
ПолеxmlId Типstring | null Обяз.нет ОписаниеВнешний идентификатор для интеграций импорта и выгрузки.
Полеid Типnumber Обяз.нет ОписаниеRO. Идентификатор типа цены. Список: Список типов цен.
Полеbase Типstring Обяз.нет ОписаниеRO. Признак базового типа цены, заполняется системой.
ПолеcreatedBy Типnumber | null Обяз.нет ОписаниеRO. Идентификатор создавшего пользователя. Список: Список пользователей.
ПолеmodifiedBy Типnumber | null Обяз.нет ОписаниеRO. Идентификатор последнего изменившего пользователя. Список: Список пользователей.
ПолеdateCreate Типstring | null Обяз.нет ОписаниеRO. Дата и время создания в формате ISO 8601.
ПолеtimestampX Типstring | null Обяз.нет ОписаниеRO. Дата и время последнего изменения в формате ISO 8601.

Поля с меткой RO доступны только для чтения. Не передавайте их в теле запроса.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-price-types/19" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Wholesale 2026", "sort": 210}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-price-types/19" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Wholesale 2026", "sort": 210}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-price-types/19', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name": "Wholesale 2026", "sort": 210}),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-price-types/19', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name": "Wholesale 2026", "sort": 210}),
})

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

Поля ответа

При успехе возвращается 200 и обновлённый тип цены целиком.

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе.
Полеdata Типobject ОписаниеОбъект типа цены.
Полеdata.id Типnumber ОписаниеRO. Идентификатор типа цены. Список: Список типов цен. Это значение передаётся в catalogGroupId при работе с ценами каталога.
Полеdata.name Типstring ОписаниеНазвание типа цены.
Полеdata.base Типstring ОписаниеRO. Y — базовый тип цены портала, N — другой тип.
Полеdata.xmlId Типstring | null ОписаниеВнешний идентификатор для интеграций.
Полеdata.sort Типnumber ОписаниеПорядок сортировки в интерфейсе Битрикс24.
Полеdata.createdBy Типnumber | null ОписаниеRO. Идентификатор создавшего пользователя. Список: Список пользователей.
Полеdata.modifiedBy Типnumber | null ОписаниеRO. Идентификатор последнего изменившего пользователя. Список: Список пользователей.
Полеdata.dateCreate Типstring | null ОписаниеRO. Дата и время создания в формате ISO 8601.
Полеdata.timestampX Типstring | null ОписаниеRO. Дата и время последнего изменения в формате ISO 8601.

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

JSON 
{
  "success": true,
  "data": {
    "base": "N",
    "createdBy": 1295,
    "dateCreate": "2026-10-14T17:18:58.000Z",
    "id": 19,
    "modifiedBy": 1295,
    "name": "Wholesale 2026",
    "sort": 210,
    "timestampX": "2026-10-14T17:18:59.000Z",
    "xmlId": "WHOLESALE"
  }
}

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

400 — попытка изменить base, тип цены не изменён:

JSON 
{
  "success": false,
  "error": {
    "code": "READONLY_FIELD",
    "message": "Field 'base' is read-only and cannot be set"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеТипа цены с указанным id нет.
HTTP400 КодINVALID_PARAMS Описаниеid не является целым неотрицательным числом, например abc.
HTTP400 КодEMPTY_UPDATE_BODY ОписаниеТело пустое или не является JSON-объектом. Передайте хотя бы одно изменяемое поле.
HTTP400 КодREADONLY_FIELD ОписаниеВ теле передано поле с меткой RO. Уберите его из запроса.
HTTP400 КодINVALID_PARAMS ОписаниеВ строковом или числовом поле передан объект или массив.
HTTP400 КодINVALID_PARAMS ОписаниеБитрикс24 отклонил параметры запроса.
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил запрос. Причина — в error.message.
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя нет права Битрикс24 «Управление типами цен».
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме только для чтения.
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа catalog.
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key.
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов Битрикс24. Для ключа OAuth-приложения проверьте пользовательскую сессию.

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

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