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

Deal product rows

GET /v1/deals/:id/products

Returns the list of product rows attached to a deal.

Parameters

Parameter Type Required Description
id (path) number yes Deal ID

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/deals/741/products" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/deals/741/products" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/deals/741/products', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Products:', data.length)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/deals/741/products', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
data array Array of product rows
data[].productId number Product ID. Catalog: GET /v1/products
data[].productName string Product name
data[].price number Unit price
data[].quantity number Quantity
data[].discount number Discount amount
data[].taxRate number/null Tax rate (%)
data[].taxIncluded boolean Tax included in price

Main fields are shown. Full list (20 fields, including priceAccount, measureCode and others): Product fields.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "productId": 1,
      "productName": "Server equipment",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "taxRate": null,
      "taxIncluded": false
    }
  ]
}

Error response example

404 — deal not found:

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

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND Deal not found
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

See also