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

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

PATCH /v1/deals/:id/products/:rowId

Обновляет товарную позицию сделки. Передайте только изменяемые поля.

Имена полей проверяются. Поле, которого нет среди записываемых, не отбрасывается молча: запрос отклоняется с 400 INVALID_PARAMS, и в тексте ошибки перечислены записываемые имена. Поля только для чтения, которые приходят в ответах товарных позиций — priceAccount, ownerId, storeId и другие, — принимаются и игнорируются, поэтому объект, прочитанный через GET, можно отправить обратно без чистки.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID сделки. Список: GET /v1/deals
rowId (path) number да ID товарной позиции, не productId из каталога. Список: GET /v1/deals/:id/products

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

Поле Тип Обяз. Описание
price number нет Цена за единицу
quantity number нет Количество
productId number нет ID товара. Каталог: GET /v1/products
productName string нет Название позиции
discountTypeId number нет Как задана скидка: 1 — суммой в поле discount, 2 — процентом в поле discountRate. Опущенное поле сохраняет прежнее значение позиции — чтобы сменить режим скидки, передайте его явно
discount number нет Сумма скидки. Учитывается только при discountTypeId равном 1
discountRate number нет Процент скидки. Учитывается только при discountTypeId равном 2
taxRate number нет Ставка налога (%)
taxIncluded boolean нет Налог включён в цену
measureCode number нет Код единицы измерения, например 796 — штука. Список: GET /v1/catalog-measures
sort number нет Сортировка

Примеры

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

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/deals/8815/products/2369" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "price": 9999, "quantity": 10 }'

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

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/deals/8815/products/2369" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "price": 9999, "quantity": 10 }'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/8815/products/2369', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ price: 9999, quantity: 10 }),
})

const { success, data } = await res.json()
console.log('Обновлено:', data.price, 'x', data.quantity)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/8815/products/2369', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ price: 9999, quantity: 10 }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Обновлённая товарная позиция целиком, id сохраняется. Поля позиции — см. Поля товаров

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

JSON
{
  "success": true,
  "data": {
    "id": 2369,
    "ownerId": 8815,
    "ownerType": "D",
    "productId": 6967,
    "productName": "Головной товар",
    "price": 9999,
    "priceAccount": 9999,
    "priceExclusive": 9999,
    "priceNetto": 9999,
    "priceBrutto": 9999,
    "quantity": 10,
    "discountTypeId": 2,
    "discountRate": 0,
    "discount": 0,
    "taxRate": null,
    "taxIncluded": false,
    "customized": "Y",
    "measureCode": 796,
    "measureName": "шт",
    "sort": 0,
    "xmlId": "sale_basket_1399",
    "type": 3,
    "storeId": null
  }
}

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

404 — позиция не найдена:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Тело содержит имя, которого нет среди записываемых полей — см. Поля товаров
400 INVALID_PARAMS В теле нет ни одного записываемого поля — пустой объект либо только поля только для чтения. В тексте ошибки перечислены записываемые имена
400 INVALID_ROW_ID rowId в адресе не целое положительное число. Сообщение — Product row ID must be a positive integer
404 ENTITY_NOT_FOUND Товарной строки с таким rowId нет. Сообщение — Элемент не найден
404 ENTITY_NOT_FOUND Строка с таким rowId есть, но принадлежит другой записи CRM, а не сделке id, либо не несёт владельца и проверку пройти не может. Сообщение — Product row not found
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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