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

Set products of a smart-process item

PUT /v1/items/:entityTypeId/:id/products

Sets the product rows of a smart-process item. Fully replaces the current list — pass every row you need.

Request fields (body)

Parameter Type Req. Description
entityTypeId (path) number yes Smart-process type ID
id (path) number yes Item ID
items array yes Array of product rows
items[].productId number yes Product ID. Catalog: GET /v1/products
items[].price number yes Price per unit
items[].quantity number yes Quantity
items[].discount number no Discount amount
items[].taxRate number no Tax rate (%)
items[].taxIncluded boolean no Tax included in price

Examples

curl — personal key

Terminal 
curl -X PUT "https://vibecode.bitrix24.com/v1/items/180/47/products" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "productId": 1, "price": 25000, "quantity": 2 },
      { "productId": 5, "price": 5000, "quantity": 1, "discount": 500 }
    ]
  }'

curl — OAuth application

Terminal 
curl -X PUT "https://vibecode.bitrix24.com/v1/items/180/47/products" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "productId": 1, "price": 25000, "quantity": 2 },
      { "productId": 5, "price": 5000, "quantity": 1, "discount": 500 }
    ]
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/items/180/47/products', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { productId: 1, price: 25000, quantity: 2 },
      { productId: 5, price: 5000, quantity: 1, discount: 500 },
    ],
  }),
})

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

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/items/180/47/products', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { productId: 1, price: 25000, quantity: 2 },
      { productId: 5, price: 5000, quantity: 1, discount: 500 },
    ],
  }),
})

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

Response fields

Array of the set rows with fields productId, productName, price, quantity, discount, taxRate, taxIncluded.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "productId": 1,
      "productName": "Server hardware",
      "price": 25000,
      "quantity": 2,
      "discount": 0,
      "taxRate": null,
      "taxIncluded": false
    },
    {
      "productId": 5,
      "productName": "Installation and setup",
      "price": 5000,
      "quantity": 1,
      "discount": 500,
      "taxRate": null,
      "taxIncluded": false
    }
  ]
}

Error response example

400 — invalid format:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "items must be an array"
  }
}

Errors

HTTP Code Description
400 INVALID_DYNAMIC_PARAM entityTypeId is not a positive integer or is reserved (1, 2, 3, 4, 7, 31)
400 INVALID_PARAMS items is not an array or an array element is not a product-row object
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.

Known specifics

Full replacement: PUT replaces the entire product list. To add a row — first fetch the current ones (GET), append the new one to the array, then send everything (PUT).

See also