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

Product fields of an item

GET /v1/items/:entityTypeId/:id/products/fields

Returns a description of the product-row fields of an item: names, types, read and write availability.

Parameters

Parameter Type Req. Description
entityTypeId (path) number yes Smart-process type ID
id (path) number yes Item ID

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/items/156/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/items/156/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/items/156/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 Req. 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 excluding tax, with discount
priceNetto double yes Net price
priceBrutto double yes Gross price
measureCode integer Unit of measure code
measureName string Unit of measure
customized char Customized (Y/N)
sort integer Sort order
type integer yes Type
storeId integer yes Store ID
ownerId integer yes Owner (item) ID
ownerType string yes Owner type

Response example

6 of 21 fields are shown. Each field is described by the keys type, isRequired, isReadOnly, isImmutable, isMultiple, isDynamic, title. Full field list — in the table above.

JSON 
{
  "success": true,
  "data": {
    "id": { "type": "integer", "isRequired": false, "isReadOnly": true, "isImmutable": false, "isMultiple": false, "isDynamic": false, "title": "ID" },
    "ownerId": { "type": "integer", "isRequired": true, "isReadOnly": false, "isImmutable": true, "isMultiple": false, "isDynamic": false, "title": "Owner ID" },
    "ownerType": { "type": "string", "isRequired": true, "isReadOnly": false, "isImmutable": true, "isMultiple": false, "isDynamic": false, "title": "Owner type" },
    "productId": { "type": "integer", "isRequired": true, "isReadOnly": false, "isImmutable": false, "isMultiple": false, "isDynamic": false, "title": "Product" },
    "price": { "type": "double", "isRequired": false, "isReadOnly": false, "isImmutable": false, "isMultiple": false, "isDynamic": false, "title": "Price" },
    "priceExclusive": { "type": "double", "isRequired": false, "isReadOnly": true, "isImmutable": false, "isMultiple": false, "isDynamic": false, "title": "Price excluding tax, with discount" }
  }
}

Error response example

404 — item not found:

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

Errors

HTTP Code Description
400 INVALID_DYNAMIC_PARAM entityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
404 ENTITY_NOT_FOUND Item not found
403 SCOPE_DENIED API key does not have the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

See also