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

Deal product fields

GET /v1/deals/:id/products/fields

Returns the field descriptions for deal product rows: names, types, read and write availability.

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/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/deals/741/products/fields" \
  -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/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

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

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

Response fields

Field Type RO Required Description
id integer yes Row ID
productId integer yes Product ID. Catalog: GET /v1/products
productName string Product name
price double Price
quantity double Quantity
discountSum double Discount amount
discountRate double Discount value (%)
discountTypeId integer Discount type
taxRate double Tax (%)
taxIncluded char Tax included in price (Y/N)
priceExclusive double yes Price without tax, with discount
priceNetto double yes Net price
priceBrutto double yes Gross price
measureCode integer Measurement unit code
measureName string Measurement unit
customized char Modified (Y/N)
sort integer Sort order
type integer yes Type
storeId integer yes Store ID
ownerId integer yes Owner (deal) ID
ownerType string yes Owner type

Response example

JSON 
{
  "success": true,
  "data": {
    "id": { "type": "integer", "isRequired": false, "isReadOnly": true, "title": "ID" },
    "ownerId": { "type": "integer", "isRequired": true, "isReadOnly": false, "isImmutable": true, "title": "Owner ID" },
    "ownerType": { "type": "string", "isRequired": true, "isReadOnly": false, "isImmutable": true, "title": "Owner type" },
    "productId": { "type": "integer", "isRequired": true, "isReadOnly": false, "title": "Product" },
    "productName": { "type": "string", "isRequired": false, "isReadOnly": false, "title": "Product name" },
    "price": { "type": "double", "isRequired": false, "isReadOnly": false, "title": "Price" },
    "priceExclusive": { "type": "double", "isRequired": false, "isReadOnly": true, "title": "Price without tax, with discount" },
    "priceNetto": { "type": "double", "isRequired": false, "isReadOnly": true, "title": "PRICE_NETTO" },
    "priceBrutto": { "type": "double", "isRequired": false, "isReadOnly": true, "title": "PRICE_BRUTTO" },
    "quantity": { "type": "double", "isRequired": false, "isReadOnly": false, "title": "Quantity" },
    "discountTypeId": { "type": "integer", "isRequired": false, "isReadOnly": false, "title": "Discount type" },
    "discountRate": { "type": "double", "isRequired": false, "isReadOnly": false, "title": "Discount value" },
    "discountSum": { "type": "double", "isRequired": false, "isReadOnly": false, "title": "Discount amount" },
    "taxRate": { "type": "double", "isRequired": false, "isReadOnly": false, "title": "Tax" },
    "taxIncluded": { "type": "char", "isRequired": false, "isReadOnly": false, "title": "Tax included in price" },
    "customized": { "type": "char", "isRequired": false, "isReadOnly": false, "title": "Modified" },
    "measureCode": { "type": "integer", "isRequired": false, "isReadOnly": false, "title": "Measurement unit code" },
    "measureName": { "type": "string", "isRequired": false, "isReadOnly": false, "title": "Measurement unit" },
    "sort": { "type": "integer", "isRequired": false, "isReadOnly": false, "title": "Sort order" },
    "type": { "type": "integer", "isRequired": false, "isReadOnly": true, "title": "TYPE" },
    "storeId": { "type": "integer", "isRequired": false, "isReadOnly": true, "title": "STORE_ID" }
  }
}

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