For AI agents: markdown of this page — /docs-content-en/entities/deals/products-add.md documentation index — /llms.txt

Add a product to a deal

POST /v1/deals/:id/products

Adds a single product row to a deal. Unlike PUT /v1/deals/:id/products, it does not replace existing rows.

Field names are validated. A field name that is not in the writable set is not dropped silently: the request is rejected with 400 INVALID_PARAMS and the error text lists the writable names. Read-only fields that appear in product-row responses — priceAccount, ownerId, storeId and others — are accepted and ignored, so an object read via GET can be sent back as is.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionDeal ID. List: GET /v1/deals

Request fields (body)

Field Type Required Description
FieldproductId Typenumber Requiredno DescriptionCatalog product ID. If set without productName, the name is taken from the catalog. Catalog: GET /v1/products. With neither productId nor productName, the row is created with no product and an empty name
FieldproductName Typestring Requiredno DescriptionRow name — for a free-text row with no catalog product
Fieldprice Typenumber Requiredno DescriptionUnit price. Without it the row is created with a zero price
Fieldquantity Typenumber Requiredno DescriptionQuantity. Without it the row is created with a quantity of 1
FielddiscountTypeId Typenumber Requiredno DescriptionHow the discount is set: 1 — as an amount in discount, 2 — as a percentage in discountRate. Defaults to 2
Fielddiscount Typenumber Requiredno DescriptionDiscount amount. Applied only when discountTypeId is 1
FielddiscountRate Typenumber Requiredno DescriptionDiscount percentage. Applied only when discountTypeId is 2
FieldtaxRate Typenumber Requiredno DescriptionTax rate (%)
FieldtaxIncluded Typeboolean Requiredno DescriptionTax included in the price
FieldmeasureCode Typenumber Requiredno DescriptionUnit of measure code, for example 796 — piece. List: GET /v1/catalog-measures
Fieldsort Typenumber Requiredno DescriptionSort order

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/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 application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/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 — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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('Row ID:', data.id)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe created product row in full, HTTP status 201. Row fields — see Product fields

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 2381,
    "ownerId": 8821,
    "ownerType": "D",
    "productId": 6967,
    "productName": "Parent product",
    "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": "pcs",
    "sort": 0,
    "xmlId": "sale_basket_1403",
    "type": 3,
    "storeId": null
  }
}

Error response example

404 — no deal with this id:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionThe body contains a field name that is not among the writable fields — see Product fields
HTTP400 CodeINVALID_PARAMS DescriptionThe body carries no writable product-row field — an empty object, or read-only fields only. The error text lists the writable names
HTTP404 CodeENTITY_NOT_FOUND DescriptionDeal not found. The message is Owner was not found
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only — see access rights
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

See also