Заменить все товарные позиции элемента v 3.0 crm.<тип>.productrow.replace
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на изменение элемента CRM, позиции которого заменяются
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.<тип>.productrow.replace заменяет весь состав товарных позиций элемента CRM переданным набором и возвращает позиции, которые получились у элемента. Тип объекта задает сегмент <тип> в имени метода. Позиции, которых нет в наборе, удаляются. Пустой набор удаляет все позиции элемента.
Имя метода для типа объекта
|
Тип объекта |
Метод |
|
Сделка |
|
|
Лид |
|
|
Предложение |
|
|
Счет |
|
|
Документ CRM |
|
|
Смарт-процесс |
|
Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId. Методы товарных позиций есть у смарт-процесса, только если в настройках типа включена привязка товаров каталога.
Имя метода пишется в нижнем регистре: crm.smartinvoice.productrow.replace, а не crm.smartInvoice.productRow.replace. На имя в другом регистре метод отвечает ошибкой «Метод не найден».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
ownerId* |
Идентификатор элемента CRM, позиции которого заменяются. Идентификатор можно получить методом crm.<тип>.list |
|
items* |
Новый набор позиций. Каждая позиция — объект с полями в формате Пустой массив |
|
select |
Список полей, которые нужно вернуть у каждой позиции в ответе, например По умолчанию: только |
Параметр items
В позиции набора передаются те же поля, что в параметре fields метода crm.<тип>.productrow.add, кроме ownerId: элемент задает параметр ownerId метода. Можно передать productId, productName, price, quantity, discountTypeId, discountRate, discountSum, taxRate, taxIncluded, measureCode, measureName, sort.
Поле id в позиции передать нельзя: метод не обновляет существующие позиции по идентификатору, а сравнивает новый набор с текущим. Позиция, которая совпала с текущей по всем полям, сохраняет свой идентификатор. Измененная позиция записывается заново и получает новый id. Актуальные идентификаторы возвращаются в ответе.
Чтобы изменить одну позицию и сохранить ее идентификатор, используйте метод crm.<тип>.productrow.update.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.productrow.replace
Примеры оставляют в элементе смарт-процесса с идентификатором типа 1038 две позиции: товар из каталога и позицию без товара. Для другого типа объекта замените имя метода по таблице выше.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerId":37,"items":[{"productId":6461,"price":100.5,"quantity":1},{"productName":"Доставка","price":700,"quantity":1}],"select":["id","productId","productName","price","quantity"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.productrow.replace
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerId":37,"items":[{"productId":6461,"price":100.5,"quantity":1},{"productName":"Доставка","price":700,"quantity":1}],"select":["id","productId","productName","price","quantity"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.productrow.replace
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductRowReplaceResult = {
items: Array<{
id: number
productId: number
productName: string
price: number
quantity: number
}>
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<ProductRowReplaceResult>(
'crm.smartprocess1038.productrow.replace',
{
ownerId: 37,
items: [
{
productId: 6461,
price: 100.5,
quantity: 1,
},
{
productName: 'Доставка',
price: 700,
quantity: 1,
},
],
select: ['id', 'productId', 'productName', 'price', 'quantity'],
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Product rows after replace:', result.items)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function replaceProductRows() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.productrow.replace',
{
ownerId: 37,
items: [
{
productId: 6461,
price: 100.5,
quantity: 1,
},
{
productName: 'Доставка',
price: 700,
quantity: 1,
},
],
select: ['id', 'productId', 'productName', 'price', 'quantity'],
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Product rows after replace:', result.items)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', replaceProductRows)
</script>
У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.smartprocess1038.productrow.replace"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"ownerId": 37,
"items": [
{
"productId": 6461,
"price": 100.5,
"quantity": 1,
},
{
"productName": "Доставка",
"price": 700,
"quantity": 1,
},
],
"select": ["id", "productId", "productName", "price", "quantity"],
},
prefer_version=3,
)
result = response["result"]
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'crm.smartprocess1038.productrow.replace',
[
'ownerId' => 37,
'items' => [
[
'productId' => 6461,
'price' => 100.5,
'quantity' => 1,
],
[
'productName' => 'Доставка',
'price' => 700,
'quantity' => 1,
],
],
'select' => ['id', 'productId', 'productName', 'price', 'quantity'],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.smartprocess1038.productrow.replace',
{
ownerId: 37,
items: [
{
productId: 6461,
price: 100.5,
quantity: 1,
},
{
productName: 'Доставка',
price: 700,
quantity: 1,
},
],
select: ['id', 'productId', 'productName', 'price', 'quantity'],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'crm.smartprocess1038.productrow.replace',
[
'ownerId' => 37,
'items' => [
[
'productId' => 6461,
'price' => 100.5,
'quantity' => 1,
],
[
'productName' => 'Доставка',
'price' => 700,
'quantity' => 1,
],
],
'select' => ['id', 'productId', 'productName', 'price', 'quantity'],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.productrow.replace", b24.Params{
"ownerId": 37,
"items": []b24.Params{
{
"productId": 6461,
"price": 100.5,
"quantity": 1,
},
{
"productName": "Доставка",
"price": 700,
"quantity": 1,
},
},
"select": []string{"id", "productId", "productName", "price", "quantity"},
})
if err != nil {
return fmt.Errorf("crm.smartprocess1038.productrow.replace: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
ProductID int `json:"productId"`
ProductName string `json:"productName"`
Price float64 `json:"price"`
Quantity float64 `json:"quantity"`
} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
fmt.Println(item.ID, item.ProductName, item.Price, item.Quantity)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"id": 2413,
"productId": 6461,
"productName": "Товар",
"price": 100.5,
"quantity": 1
},
{
"id": 2415,
"productId": 0,
"productName": "Доставка",
"price": 700,
"quantity": 1
}
]
},
"time": {
"start": 1793709949,
"finish": 1793709949.853585,
"duration": 0.8535850048065186,
"processing": 0,
"date_start": "2026-11-03T15:45:49+03:00",
"date_finish": "2026-11-03T15:45:49+03:00",
"operating_reset_at": 1793710260,
"operating": 0.3442521095275879
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.items |
Позиции элемента после замены с полями из |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта",
"validation": [
{
"message": "Поле \"id\" не доступно к заполнению",
"field": "items.0.id"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Ошибка в позиции набора указывает ее номер в items, начиная с 0: items.0.id — поле id первой позиции. Если в наборе есть ошибка, метод не меняет позиции элемента.
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте |
|
|
Обязательное поле |
Передайте массив |
|
|
В списке "items" больше 1000 элементов |
Передайте не больше 1000 позиций |
|
|
В поле |
Передайте каждую позицию объектом |
|
|
В товарной позиции 0 нет полей, доступных для изменения |
Передайте в позиции хотя бы одно поле |
|
|
Поле товарной позиции "ownerId" доступно только для чтения |
Уберите |
|
|
В поле |
Передайте значение того типа, который указан в описании поля. В этой ошибке номер позиции не указывается, найдите позицию по имени поля |
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Поле "id" не доступно к заполнению |
Уберите |
|
|
Значение поля не содержится в списке допустимых значений |
Товара нет в каталоге или у вас нет к нему доступа. Проверьте |
Элемент не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Элемента из |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Проверьте имя поля в позиции с указанным номером. Имена полей пишутся в camelCase: |
Метод не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Метод |
Проверьте имя метода: оно пишется в нижнем регистре, например |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |