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

Scope: crm

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

Метод сохраняет товарную позицию объекта CRM. Обратите внимание, что метод перезапишет все уже существующие товарные позиции, привязанные к объекту. Таким образом, метод заменяет уже существующие товарные позиции на те, что были присланы.

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

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

Название `тип`	Описание
ownerId* `integer`	Идентификатор объекта CRM
ownerType* `string`	Идентификатор `типа объекта CRM`. Передавайте Краткий символьный код типа
productRows* `object[]`	Массив объектов с информацией о товарных позициях, которые нужно сохранить в объекте

Параметр productRows

Название `тип`	Описание
productId `catalog_product.id`	Идентификатор товара из каталога
productName `string`	Название товара в товарной позиции. Если не передано и передано значение productId, то используется название товара из каталога товаров
price `double`	Цена за единицу товарной позиции с учетом скидок и налогов
quantity `double`	Количество товара. По умолчанию — 1
discountTypeId `integer`	Тип скидки. Возможные значения: `1` — абсолютное значение `2` — процентное значение По умолчанию — 2
discountRate `double`	Значение скидки в процентах (если используется тип скидки с процентным значением)
discountSum `double`	Абсолютное значение скидки (если используется тип скидки с абсолютным значением)
taxRate `double`	Ставка налога в процентах
taxIncluded `string`	Индикатор того, включен ли налог в стоимость. Возможные значения: `Y` – налог включен `N` – налог не включен По умолчанию - N
measureCode `catalog_measure.code`	Код единицы измерения. Если не передано и передано значение productId, то используется единица измерения из каталога товаров
sort `integer`	Сортировка

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.item.productrow.set', {
        			ownerType: 'D',
        			ownerId: 13143,
        			productRows: [{
        					productId: 9621,
        					price: 99999.99,
        					quantity: 1,
        					sort: 10,
        				},
        				{
        					productId: 9623,
        					price: 15900.00,
        					quantity: 2,
        					sort: 10,
        				},
        
        			],
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(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.00,
                                '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.00,
                        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.00,
                        'quantity' => 2,
                        'sort' => 10,
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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",
                    "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",
                    "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 `object`	Корневой элемент ответа
productRow `crm_item_product_row[]`	Массив объектов, содержащий информацию о всех товарных позициях объекта CRM
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

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

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

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

Код	Описание
`ENTITY_TYPE_NOT_SUPPORTED`	Работа с данным типом объектов не поддерживается
`ACCESS_DENIED`	Доступ запрещен
`OWNER_NOT_FOUND`	Переданный объект CRM не найден
`100`	Не переданы обязательные параметры
`0`	Другие ошибки (например, фатальные ошибки)

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

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

Получить информацию о товарной позиции по id

Получить список товарных позиций

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

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

Параметр productRowsПараметр productRows

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

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

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

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

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

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