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

Добавить товар в сделку

POST /v1/deals/:id/products

Добавляет одну товарную позицию в сделку. В отличие от PUT /v1/deals/:id/products, не заменяет существующие позиции.

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

Параметры

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

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

Поле Тип Обяз. Описание
productId number нет ID товара из каталога. Если задан без productName, имя подставляется из каталога. Каталог: GET /v1/products. Без productId и productName позиция создаётся без товара и с пустым названием
productName string нет Название позиции — для произвольной строки без товара из каталога
price number нет Цена за единицу. Без него позиция создаётся с нулевой ценой
quantity number нет Количество. Без него позиция создаётся с количеством 1
discountTypeId number нет Как задана скидка: 1 — суммой в поле discount, 2 — процентом в поле discountRate. По умолчанию 2
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 POST "https://vibecode.bitrix24.tech/v1/deals/8821/products" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "productId": 6967, "price": 25000, "quantity": 2 }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/deals/8821/products" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "productId": 6967, "price": 25000, "quantity": 2 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/8821/products', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ productId: 6967, price: 25000, quantity: 2 }),
})

const { success, data } = await res.json()
console.log('ID строки:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deals/8821/products', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ productId: 6967, price: 25000, quantity: 2 }),
})

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

Поля ответа

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

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

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

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

404 — сделки с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Owner was not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Тело содержит имя, которого нет среди записываемых полей — см. Поля товаров
400 INVALID_PARAMS В теле нет ни одного записываемого поля — пустой объект либо только поля только для чтения. В тексте ошибки перечислены записываемые имена
404 ENTITY_NOT_FOUND Сделка не найдена. Сообщение — Owner was not found
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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