Установить товары в сделку crm.deal.productrows.set

Scope: crm

Кто может выполнять метод: пользователь с правом «изменения» сделки

DEPRECATED

Развитие метода остановлено. Используйте crm.item.productrow.*.

Метод crm.deal.productrows.set создает или обновляет товарные позиции сделки. Существующие позиции, не переданные в метод, будут удалены из сделки.

Чтобы изменить только одну позицию, используйте методы crm.item.productrow.*.

Название
тип

Описание

id^*
integer

Идентификатор сделки. Можно получить с помощью метода получения списка сделок: crm.deal.list или при создании сделки: crm.deal.add

rows
object[]

Товарные позиции

Массив объектов, вида:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

где

field_n — название поля товарной позиции
value_n — значение данного поля

Список доступных полей описан ниже

Список доступных полей у товарных позиций

Название `тип`	Описание
PRODUCT_ID `integer`	Идентификатор товара в каталоге. Можно получить список товаров с помощью метода `catalog.product.list` `0` если не из каталога По умолчанию - `0`
PRODUCT_NAME `string`	Наименование товарной позиции. Если передан `PRODUCT_ID`, то название будет взято у товара Если поля `PRODUCT_ID` и `PRODUCT_NAME` не переданы, то `PRODUCT_NAME` будет равен `[{id}]`, где `{id}` - Идентификатор созданной товарной позиции
PRICE `double`	Итоговая стоимость товара за единицу По умолчанию - `0.0`
PRICE_EXCLUSIVE `double`	Стоимость за единицу с учетом скидок, без учета налогов
PRICE_NETTO `double`	Стоимость за единицу без учета скидок и налогов
PRICE_BRUTTO `double`	Стоимость за единицу без учета скидок, но с учетом налогов
QUANTITY `double`	Количество единиц товара По умолчанию - `1.0`
DISCOUNT_TYPE_ID `integer`	Тип скидки Возможные типы: `1` - Абсолютный `2` - Процентный По умолчанию - `2`
DISCOUNT_RATE `double`	Значение скидки в процентах (если используется тип скидки с процентным значением) По умолчанию - `0.0`
DISCOUNT_SUM `double`	Абсолютное значение скидки (если используется тип скидки с абсолютным значением) По умолчанию - `0.0`
TAX_RATE `double`	Ставка налога в процентах
TAX_INCLUDED `char`	Индикатор того, включен ли налог в стоимость Возможные значения: `Y` – налог включен `N` – налог не включен По умолчанию - `N`
MEASURE_CODE `catalog_measure.code`	Код единицы измерения Если передан `PRODUCT_ID`, то по умолчанию будет взято значение из товара, иначе `0`
MEASURE_NAME `string`	Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.) Если передан `PRODUCT_ID`, то по умолчанию будет взято значение из товара, иначе `""`
SORT `integer`	Сортировка По умолчанию - `0`

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":5,"rows":[{"PRODUCT_ID":456,"PRICE":1000,"QUANTITY":10,"DISCOUNT_TYPE_ID":1,"DISCOUNT_SUM":100,"TAX_RATE":13,"MEASURE_CODE":796,"MEASURE_NAME":"шт","SORT":10},{"PRODUCT_NAME":"Товар #2","PRICE":500,"QUANTITY":5,"DISCOUNT_TYPE_ID":2,"DISCOUNT_RATE":10,"TAX_RATE":10,"MEASURE_CODE":166,"MEASURE_NAME":"кг","SORT":20}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.productrows.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":5,"rows":[{"PRODUCT_ID":456,"PRICE":1000,"QUANTITY":10,"DISCOUNT_TYPE_ID":1,"DISCOUNT_SUM":100,"TAX_RATE":13,"MEASURE_CODE":796,"MEASURE_NAME":"шт","SORT":10},{"PRODUCT_NAME":"Товар #2","PRICE":500,"QUANTITY":5,"DISCOUNT_TYPE_ID":2,"DISCOUNT_RATE":10,"TAX_RATE":10,"MEASURE_CODE":166,"MEASURE_NAME":"кг","SORT":20}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.productrows.set

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.productrows.set',
        		{
        			id: 5,
        			rows: [
        				{
        					PRODUCT_ID: 456,
        					PRICE: 1000,
        					QUANTITY: 10,
        					DISCOUNT_TYPE_ID: 1,
        					DISCOUNT_SUM: 100,
        					TAX_RATE: 13,
        					MEASURE_CODE: 796,
        					MEASURE_NAME: "шт",
        					SORT: 10,
        				},
        				{
        					PRODUCT_NAME: "Товар #2",
        					PRICE: 500,
        					QUANTITY: 5,
        					DISCOUNT_TYPE_ID: 2,
        					DISCOUNT_RATE: 10,
        					TAX_RATE: 10,
        					MEASURE_CODE: 166,
        					MEASURE_NAME: "кг",
        					SORT: 20,
        				},
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.productrows.set',
                    [
                        'id'   => 5,
                        'rows' => [
                            [
                                'PRODUCT_ID'       => 456,
                                'PRICE'           => 1000,
                                'QUANTITY'        => 10,
                                'DISCOUNT_TYPE_ID' => 1,
                                'DISCOUNT_SUM'    => 100,
                                'TAX_RATE'        => 13,
                                'MEASURE_CODE'    => 796,
                                'MEASURE_NAME'    => "шт",
                                'SORT'            => 10,
                            ],
                            [
                                'PRODUCT_NAME'     => "Товар #2",
                                'PRICE'           => 500,
                                'QUANTITY'        => 5,
                                'DISCOUNT_TYPE_ID' => 2,
                                'DISCOUNT_RATE'   => 10,
                                'TAX_RATE'        => 10,
                                'MEASURE_CODE'    => 166,
                                'MEASURE_NAME'    => "кг",
                                'SORT'            => 20,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting deal product rows: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.productrows.set',
            {
                id: 5,
                rows: [
                    {
                        PRODUCT_ID: 456,
                        PRICE: 1000,
                        QUANTITY: 10,
                        DISCOUNT_TYPE_ID: 1,
                        DISCOUNT_SUM: 100,
                        TAX_RATE: 13,
                        MEASURE_CODE: 796,
                        MEASURE_NAME: "шт",
                        SORT: 10,
                    },
                    {
                        PRODUCT_NAME: "Товар #2",
                        PRICE: 500,
                        QUANTITY: 5,
                        DISCOUNT_TYPE_ID: 2,
                        DISCOUNT_RATE: 10,
                        TAX_RATE: 10,
                        MEASURE_CODE: 166,
                        MEASURE_NAME: "кг",
                        SORT: 20,
                    },
                ],
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.productrows.set',
            [
                'id' => 5,
                'rows' => [
                    [
                        'PRODUCT_ID' => 456,
                        'PRICE' => 1000,
                        'QUANTITY' => 10,
                        'DISCOUNT_TYPE_ID' => 1,
                        'DISCOUNT_SUM' => 100,
                        'TAX_RATE' => 13,
                        'MEASURE_CODE' => 796,
                        'MEASURE_NAME' => "шт",
                        'SORT' => 10,
                    ],
                    [
                        'PRODUCT_NAME' => "Товар #2",
                        'PRICE' => 500,
                        'QUANTITY' => 5,
                        'DISCOUNT_TYPE_ID' => 2,
                        'DISCOUNT_RATE' => 10,
                        'TAX_RATE' => 10,
                        'MEASURE_CODE' => 166,
                        'MEASURE_NAME' => "кг",
                        'SORT' => 20,
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
          "result": true,
          "time": {
            "start": 1735134795.171273,
            "finish": 1735134796.404978,
            "duration": 1.2337050437927246,
            "processing": 0.9462978839874268,
            "date_start": "2024-12-25T15:53:15+02:00",
            "date_finish": "2024-12-25T15:53:16+02:00",
            "operating": 0
          }
        }

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

Название `тип`	Описание
result `boolean`	Корневой элемент ответа, содержит `true` в случае успеха
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
          "error": "ERROR_CORE",
          "error_description": "Discount Sum (DISCOUNT_SUM) is required if Percentage Discount Type (DISCOUNT_TYPE_ID) is defined and Discount Rate (DISCOUNT_RATE) is 100%<br>"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Описание	Значение
The parameter id is invalid or not defined	В параметр `id` передано некорректное значение
Access denied	У пользователя нет прав на «изменение» сделки
Not found	Сделка с переданным `id` не найдена
Discount Rate (`DISCOUNT_RATE`) is required if Percentage Discount Type (`DISCOUNT_TYPE_ID`) is defined	Было передано `DISCOUNT_TYPE_ID = 2` и не передано `DISCOUNT_RATE`
Discount Sum (`DISCOUNT_SUM`) is required if Percentage Discount Type (`DISCOUNT_TYPE_ID`) is defined and Discount Rate (`DISCOUNT_RATE`) is 100%	Было передано `DISCOUNT_RATE = 100` и `DISCOUNT_TYPE_ID = 2` и не передано `DISCOUNT_SUM`
Discount Sum (`DISCOUNT_SUM`) is required if Monetary Discount Type (`DISCOUNT_TYPE_ID`) is defined	Было передано `DISCOUNT_TYPE_ID = 1` и не передано `DISCOUNT_SUM`

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить товары сделки crm.deal.productrows.get

Получить поля сделки

Получить товары сделки

Установить товары в сделку crm.deal.productrows.set

Список доступных полей у товарных позицийСписок доступных полей у товарных позиций

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

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

Статусы и коды системных ошибокСтатусы и коды системных ошибок

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