Добавить товарную позицию в объект CRM crm.item.productrow.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: требуется право на изменение объекта CRM, в который добавляется товарная позиция

Метод crm.item.productrow.add добавляет товарную позицию в объект CRM.

Метод добавляет одну позицию и не изменяет остальные. Чтобы заменить весь набор товарных позиций объекта CRM, используйте метод crm.item.productrow.set.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект, содержащий значения полей для добавления товарной позиции в объект CRM (подробное описание)

Параметр fields

Передайте productId (идентификатор товара из каталога) или productName (название произвольной позиции). Полный список полей с типами и признаком доступности для записи возвращает метод crm.item.productrow.fields.

Название
тип

Описание

ownerId*
integer

Идентификатор объекта CRM

ownerType*
string

Краткий символьный код типа объекта CRM: L — лид, D — сделка, Q — предложение, SI — новый счет, T и шестнадцатеричный идентификатор типа — смарт-процесс

productId
catalog_product.id

Идентификатор товара из каталога.
Если не передан, создается позиция без привязки к каталогу

productName
string

Название товара в товарной позиции.
Если не передано, но передано значение productId, то используется название товара из каталога товаров

price
double

Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM.
Если не передана, цена будет равна 0 — даже когда передан productId с ценой в каталоге

quantity
double

Количество товара.
По умолчанию — 1

discountTypeId
integer

Тип скидки.
Возможные значения:

  • 1 — абсолютное значение
  • 2 — процентное значение
    По умолчанию — 2

discountRate
double

Значение скидки в процентах (если используется тип скидки с процентным значением)

discountSum
double

Абсолютное значение скидки (если используется тип скидки с абсолютным значением)

taxRate
double

Ставка налога в процентах

taxIncluded
string

Индикатор того, включен ли налог в стоимость.
Возможные значения:

  • Y — налог включен
  • N — налог не включен
    По умолчанию — N

taxName
string

Название налоговой ставки. Например, НДС 20.
Это только подпись: в расчете участвует значение taxRate, а taxName метод сохраняет как есть. Если не передать taxName, позиция без налога получит значение Без НДС

measureCode
catalog_measure.code

Код единицы измерения.
Если не передано, но передано значение productId, то используется единица измерения из каталога товаров

sort
integer

Сортировка

Поля id, priceAccount, priceExclusive, priceNetto, priceBrutto, measureName, type, customized, xmlId и storeId метод рассчитывает сам. Переданные значения этих полей метод игнорирует без ошибки.

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ownerId":13142,"ownerType":"D","productId":9621,"price":80000,"quantity":2,"discountTypeId":2,"discountRate":20,"taxRate":20,"taxIncluded":"Y","measureCode":796,"sort":10}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ownerId":13142,"ownerType":"D","productId":9621,"price":80000,"quantity":2,"discountTypeId":2,"discountRate":20,"taxRate":20,"taxIncluded":"Y","measureCode":796,"sort":10},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.productrow.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductRowAddResult = {
  productRow: {
    id: number
    ownerId: number
    ownerType: string
    productId: number
    price: number
    quantity: number
    discountTypeId: number
    discountRate: number
    taxRate: number | null
    taxIncluded: string
    measureCode: number
    sort: number
    type: number
    productName: string
    priceAccount: number
    priceExclusive: number
    priceNetto: number
    priceBrutto: number
    discountSum: number
    customized: string
    measureName: string
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<ProductRowAddResult>({
    method: 'crm.item.productrow.add',
    params: {
      fields: {
        ownerId: 13142,
        ownerType: 'D',
        productId: 9621,
        price: 80000,
        quantity: 2,
        discountTypeId: 2,
        discountRate: 20,
        taxRate: 20,
        taxIncluded: 'Y',
        measureCode: 796,
        sort: 10,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.productRow.id, result.productRow.productName, result.productRow.price)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addProductRow() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.item.productrow.add',
        params: {
          fields: {
            ownerId: 13142,
            ownerType: 'D',
            productId: 9621,
            price: 80000,
            quantity: 2,
            discountTypeId: 2,
            discountRate: 20,
            taxRate: 20,
            taxIncluded: 'Y',
            measureCode: 796,
            sort: 10,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.productRow.id, result.productRow.productName, result.productRow.price)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addProductRow)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.item.productrow.add(
        fields={
            "ownerId": 13142,
            "ownerType": "D",
            "productId": 9621,
            "price": 80000,
            "quantity": 2,
            "discountTypeId": 2,
            "discountRate": 20,
            "taxRate": 20,
            "taxIncluded": "Y",
            "measureCode": 796,
            "sort": 10,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.item.productrow.add',
            [
                'fields' => [
                    'ownerId'        => 13142,
                    'ownerType'      => 'D',
                    'productId'      => 9621,
                    'price'          => 80000,
                    'quantity'       => 2,
                    'discountTypeId' => 2,
                    'discountRate'   => 20,
                    'taxRate'        => 20,
                    'taxIncluded'    => 'Y',
                    'measureCode'    => 796,
                    'sort'           => 10,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding product row: ' . $e->getMessage();
}
BX24.callMethod(
    'crm.item.productrow.add', {
        fields: {
            ownerId: 13142,
            ownerType: 'D',
            productId: 9621,
            price: 80000,
            quantity: 2,
            discountTypeId: 2,
            discountRate: 20,
            taxRate: 20,
            taxIncluded: 'Y',
            measureCode: 796,
            sort: 10,
        },
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.item.productrow.add',
    [
        'fields' => [
            'ownerId' => 13142,
            'ownerType' => 'D',
            'productId' => 9621,
            'price' => 80000,
            'quantity' => 2,
            'discountTypeId' => 2,
            'discountRate' => 20,
            'taxRate' => 20,
            'taxIncluded' => 'Y',
            'measureCode' => 796,
            'sort' => 10,
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.productrow.add", b24.Params{
	"fields": b24.Params{
		"ownerId":        13142,
		"ownerType":      "D",
		"productId":      9621,
		"price":          80000,
		"quantity":       2,
		"discountTypeId": 2,
		"discountRate":   20,
		"taxRate":        20,
		"taxIncluded":    "Y",
		"measureCode":    796,
		"sort":           10,
	},
})
if err != nil {
	return fmt.Errorf("crm.item.productrow.add: %w", err)
}

// Метод заворачивает ответ в объект с ключом "productRow".
raw, ok := b24.Unwrap(res.Result, "productRow")
if !ok {
	return fmt.Errorf("в ответе нет ключа productRow")
}

var item struct {
	ID        b24.ID  `json:"id"`
	OwnerID   b24.ID  `json:"ownerId"`
	OwnerType string  `json:"ownerType"`
	ProductID b24.ID  `json:"productId"`
	Price     float64 `json:"price"`
	Quantity  float64 `json:"quantity"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.OwnerID)

Ответ в случае успеха

HTTP-статус: 200

{
   "result":{
      "productRow":{
         "id":17647,
         "ownerId":13142,
         "ownerType":"D",
         "productId":9621,
         "price":80000,
         "quantity":2,
         "discountTypeId":2,
         "discountRate":20,
         "taxRate":20,
         "taxIncluded":"Y",
         "measureCode":796,
         "sort":10,
         "type":4,
         "productName":"iphone 14",
         "priceAccount":80000,
         "priceExclusive":66666.66666667,
         "priceNetto":83333.33333333,
         "priceBrutto":100000,
         "discountSum":16666.66666667,
         "customized":"Y",
         "measureName":"шт",
         "xmlId":""
      }
   },
   "time":{
      "start":1716887721.77879,
      "finish":1716887723.259695,
      "duration":1.4809050559997559,
      "processing":1.2986550331115723,
      "date_start":"2024-05-28T12:15:21+03:00",
      "date_finish":"2024-05-28T12:15:23+03:00"
   }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

productRow
crm_item_product_row

Объект с информацией о добавленной товарной позиции

Обработка ошибок

HTTP-статус: 400

{
   "error":"OWNER_NOT_FOUND",
   "error_description":"Owner was not found"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

ENTITY_TYPE_NOT_SUPPORTED

Этот тип объектов CRM не поддерживает товарные позиции

ACCESS_DENIED

У пользователя нет права на изменение объекта CRM, в который добавляется позиция

OWNER_NOT_FOUND

Переданный объект CRM не найден

INVALID_ARG_VALUE

Товар с переданным productId не найден в каталоге

100

Не переданы обязательные параметры

0

Другие ошибки (например, фатальные ошибки)

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение