Сохранить товарные позиции объекта CRM crm.item.productrow.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: требуется право на изменение объекта CRM, товарные позиции которого сохраняются
Метод crm.item.productrow.set сохраняет набор товарных позиций объекта CRM.
Метод заменяет все товарные позиции объекта CRM на переданный набор. Позиции, которых нет в productRows, удаляются вместе со своими строками в оплатах, а сумма объекта CRM пересчитывается. Если передать пустой массив, объект CRM останется без товарных позиций.
Чтобы добавить одну позицию, не изменяя остальные, используйте метод crm.item.productrow.add.
Набор сохраняется целиком: если хотя бы одна позиция не прошла проверку, метод вернет ошибку INVALID_ARG_VALUE и не изменит товарные позиции объекта CRM.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
ownerId* |
Идентификатор объекта CRM |
|
ownerType* |
Краткий символьный код типа объекта CRM: |
|
productRows* |
Массив объектов с информацией о товарных позициях, которые нужно сохранить в объекте (подробное описание) |
Параметр productRows
Передайте в каждой позиции productId (идентификатор товара из каталога) или productName (название произвольной позиции).
|
Название |
Описание |
|
Идентификатор существующей товарной позиции. Получить его можно методом crm.item.productrow.list. |
|
|
productId |
Идентификатор товара из каталога. |
|
productName |
Название товара в товарной позиции. |
|
price |
Цена за единицу товарной позиции с учетом скидок и налогов. Указывается в валюте объекта CRM. |
|
quantity |
Количество товара. |
|
discountTypeId |
Тип скидки.
|
|
discountRate |
Значение скидки в процентах (если используется тип скидки с процентным значением) |
|
discountSum |
Абсолютное значение скидки (если используется тип скидки с абсолютным значением) |
|
taxRate |
Ставка налога в процентах |
|
taxIncluded |
Индикатор того, включен ли налог в стоимость.
|
|
taxName |
Название налоговой ставки. Например, |
|
measureCode |
Код единицы измерения. |
|
sort |
Сортировка |
Поля priceAccount, priceExclusive, priceNetto, priceBrutto, measureName, type, customized, xmlId и storeId метод рассчитывает сам. Переданные значения этих полей метод игнорирует без ошибки: обратная отправка позиции, полученной методом crm.item.productrow.list, их не изменит.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerType":"D","ownerId":13143,"productRows":[{"productId":9621,"price":99999.99,"quantity":1,"sort":10},{"productId":9623,"price":15900,"quantity":2,"sort":10}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerType":"D","ownerId":13143,"productRows":[{"productId":9621,"price":99999.99,"quantity":1,"sort":10},{"productId":9623,"price":15900,"quantity":2,"sort":10}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.productrow.set
// 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 ProductRowsResult = {
productRows: {
id: number
ownerId: number
ownerType: string
productId: number
productName: string
price: number
priceAccount: number
priceExclusive: number
priceNetto: number
priceBrutto: number
quantity: number
discountTypeId: number
discountRate: number
discountSum: number
taxRate: number | null
taxIncluded: string
taxName: string
customized: string
measureCode: number
measureName: string
sort: number
xmlId: string
type: number
}[]
}
try {
const response = await $b24.actions.v2.call.make<ProductRowsResult>({
method: 'crm.item.productrow.set',
params: {
ownerType: 'D',
ownerId: 13143,
productRows: [
{
productId: 9621,
price: 99999.99,
quantity: 1,
sort: 10,
},
{
productId: 9623,
price: 15900,
quantity: 2,
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.productRows)
}
} 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 setProductRows() {
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.set',
params: {
ownerType: 'D',
ownerId: 13143,
productRows: [
{
productId: 9621,
price: 99999.99,
quantity: 1,
sort: 10,
},
{
productId: 9623,
price: 15900,
quantity: 2,
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.productRows)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setProductRows)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.productrow.set(
owner_type="D",
owner_id=13143,
product_rows=[
{
"productId": 9621,
"price": 99999.99,
"quantity": 1,
"sort": 10,
},
{
"productId": 9623,
"price": 15900,
"quantity": 2,
"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.set',
[
'ownerType' => 'D',
'ownerId' => 13143,
'productRows' => [
[
'productId' => 9621,
'price' => 99999.99,
'quantity' => 1,
'sort' => 10,
],
[
'productId' => 9623,
'price' => 15900,
'quantity' => 2,
'sort' => 10,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting product rows: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.productrow.set', {
ownerType: 'D',
ownerId: 13143,
productRows: [{
productId: 9621,
price: 99999.99,
quantity: 1,
sort: 10,
},
{
productId: 9623,
price: 15900,
quantity: 2,
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.set',
[
'ownerType' => 'D',
'ownerId' => 13143,
'productRows' => [
[
'productId' => 9621,
'price' => 99999.99,
'quantity' => 1,
'sort' => 10,
],
[
'productId' => 9623,
'price' => 15900,
'quantity' => 2,
'sort' => 10,
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.productrow.set", b24.Params{
"ownerType": "D",
"ownerId": 13143,
"productRows": []b24.Params{
{
"productId": 9621,
"price": 99999.99,
"quantity": 1,
"sort": 10,
},
{
"productId": 9623,
"price": 15900,
"quantity": 2,
"sort": 10,
},
},
})
if err != nil {
return fmt.Errorf("crm.item.productrow.set: %w", err)
}
// Метод заворачивает ответ в объект с ключом "productRows".
raw, ok := b24.Unwrap(res.Result, "productRows")
if !ok {
return fmt.Errorf("в ответе нет ключа productRows")
}
var items []struct {
ID b24.ID `json:"id"`
OwnerID b24.ID `json:"ownerId"`
OwnerType string `json:"ownerType"`
ProductID b24.ID `json:"productId"`
ProductName string `json:"productName"`
Price float64 `json:"price"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Ответ в случае успеха
HTTP-статус: 200
{
"result":{
"productRows":[
{
"id":17654,
"ownerId":13143,
"ownerType":"D",
"productId":9621,
"productName":"iphone 14",
"price":99999.99,
"priceAccount":99999.99,
"priceExclusive":99999.99,
"priceNetto":99999.99,
"priceBrutto":99999.99,
"quantity":1,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"N",
"taxName":"Без НДС",
"customized":"Y",
"measureCode":796,
"measureName":"шт",
"sort":10,
"xmlId":"",
"type":4
},
{
"id":17655,
"ownerId":13143,
"ownerType":"D",
"productId":9623,
"productName":"iphone 10xs",
"price":15900,
"priceAccount":15900,
"priceExclusive":15900,
"priceNetto":15900,
"priceBrutto":15900,
"quantity":2,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"N",
"taxName":"Без НДС",
"customized":"Y",
"measureCode":796,
"measureName":"шт",
"sort":10,
"xmlId":"",
"type":4
}
]
},
"time":{
"start":1716895718.887229,
"finish":1716895719.316293,
"duration":0.4290640354156494,
"processing":0.20114707946777344,
"date_start":"2024-05-28T14:28:38+03:00",
"date_finish":"2024-05-28T14:28:39+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
productRows |
Массив объектов с информацией о всех товарных позициях объекта CRM после сохранения. Метод возвращает их сразу, без постраничной навигации |
Обработка ошибок
HTTP-статус: 400
{
"error":"OWNER_NOT_FOUND",
"error_description":"Owner was not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Этот тип объектов CRM не поддерживает товарные позиции |
|
|
У пользователя нет права на изменение объекта CRM |
|
|
Переданный объект CRM не найден |
|
|
Товар с переданным |
|
|
Не переданы обязательные параметры |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Товарные позиции в объектах CRM: обзор методов
- Добавить товарную позицию в объект CRM crm.item.productrow.add
- Изменить товарную позицию объекта CRM crm.item.productrow.update
- Получить информацию о товарной позиции по id crm.item.productrow.get
- Получить товарные позиции объекта CRM crm.item.productrow.list
- Удалить товарную позицию из объекта CRM crm.item.productrow.delete
- Получить неоплаченные товарные позиции объекта CRM crm.item.productrow.getAvailableForPayment
- Получить список полей товарных позиций crm.item.productrow.fields