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

Scope: crm

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

DEPRECATED

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

Метод crm.deal.productrows.get возвращает товарные позиции сделки.

Название `тип`	Описание
id^* `integer`	Идентификатор сделки. Можно получить с помощью метода получения списка сделок: `crm.deal.list` или при создании сделки: `crm.deal.add`

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

Примеры кода

Получить товарные позиции сделки с id = 5

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":5}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.productrows.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":5,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.productrows.get

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.productrows.get',
        		{
        			id: 5,
        		}
        	);
        	
        	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.get',
                    [
                        'id' => 5,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting deal product rows: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.productrows.get',
            {
                id: 5,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
        	'crm.deal.productrows.get',
        	[
        		'id' => 5
        	]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
        	"result": [
        		{
        			"ID": "5",
        			"OWNER_ID": "5",
        			"OWNER_TYPE": "D",
        			"PRODUCT_ID": 450,
        			"PRODUCT_NAME": "Товар #2",
        			"ORIGINAL_PRODUCT_NAME": "Товар #2",
        			"PRODUCT_DESCRIPTION": null,
        			"PRICE": 899.1,
        			"PRICE_EXCLUSIVE": 899.1,
        			"PRICE_NETTO": 999,
        			"PRICE_BRUTTO": 999,
        			"PRICE_ACCOUNT": "899.10",
        			"QUANTITY": 1,
        			"DISCOUNT_TYPE_ID": 2,
        			"DISCOUNT_RATE": 10,
        			"DISCOUNT_SUM": 99.9,
        			"TAX_RATE": null,
        			"TAX_INCLUDED": "Y",
        			"CUSTOMIZED": "Y",
        			"MEASURE_CODE": 796,
        			"MEASURE_NAME": "шт",
        			"SORT": 10,
        			"XML_ID": "sale_basket_651",
        			"TYPE": 1,
        			"STORE_ID": 0,
        			"RESERVE_ID": 31,
        			"DATE_RESERVE_END": "26.12.2024",
        			"RESERVE_QUANTITY": 1
        		},
        		{
        			"ID": "4",
        			"OWNER_ID": "5",
        			"OWNER_TYPE": "D",
        			"PRODUCT_ID": 449,
        			"PRODUCT_NAME": "Товар #1",
        			"ORIGINAL_PRODUCT_NAME": "Товар #1",
        			"PRODUCT_DESCRIPTION": "Детальное описание",
        			"PRICE": 100,
        			"PRICE_EXCLUSIVE": 100,
        			"PRICE_NETTO": 100,
        			"PRICE_BRUTTO": 100,
        			"PRICE_ACCOUNT": "100.00",
        			"QUANTITY": 1,
        			"DISCOUNT_TYPE_ID": 2,
        			"DISCOUNT_RATE": 0,
        			"DISCOUNT_SUM": 0,
        			"TAX_RATE": null,
        			"TAX_INCLUDED": "Y",
        			"CUSTOMIZED": "Y",
        			"MEASURE_CODE": 796,
        			"MEASURE_NAME": "шт",
        			"SORT": 20,
        			"XML_ID": "sale_basket_650",
        			"TYPE": 1,
        			"STORE_ID": 1,
        			"RESERVE_ID": 30,
        			"DATE_RESERVE_END": "26.12.2024",
        			"RESERVE_QUANTITY": 1
        		}
        	],
        	"time": {
        		"start": 1734969122.936213,
        		"finish": 1734969123.586089,
        		"duration": 0.6498758792877197,
        		"processing": 0.14046597480773926,
        		"date_start": "2024-12-23T17:52:02+02:00",
        		"date_finish": "2024-12-23T17:52:03+02:00",
        		"operating": 0
        	}
        }

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

Название `тип`	Описание
result `productrow[]`	Корневой элемент ответа, содержащий массив товарных позиций сделки
time `time`	Информация о времени выполнения запроса

Тип productrow

Название `тип`	Описание
ID `integer`	Идентификатор товарной позиции
OWNER_ID `integer`	Идентификатор элемента, к которому привязан товар. Для данного метода всегда будет равен `id` сделки
OWNER_TYPE `string`	Строковый идентификатор типа объекта, к которому привязан товар. Для данного метода всегда будет равен `D`
PRODUCT_ID `integer`	Идентификатор товара в каталоге. `0` если не из каталога Для получения более подробной информации о товаре используйте `catalog.product.get`
PRODUCT_NAME `string`	Наименование товарной позиции
ORIGINAL_PRODUCT_NAME `string`	Наименование товарной позиции в каталоге
PRODUCT_DESCRIPTION `string`	Описание товарной позиции
PRICE `double`	Итоговая стоимость товара за единицу
PRICE_EXCLUSIVE `double`	Стоимость за единицу с учетом скидок, без учета налогов
PRICE_NETTO `double`	Стоимость за единицу без учета скидок и налогов
PRICE_BRUTTO `double`	Стоимость за единицу без учета скидок, но с учетом налогов
PRICE_ACCOUNT `string`	Стоимость товара в "валюте отчетов"
QUANTITY `integer`	Количество единиц товара
DISCOUNT_TYPE_ID `integer`	Тип скидки Возможные типы: `1` - Абсолютный `2` - Процентный
DISCOUNT_RATE `double`	Значение скидки в процентах (если используется тип скидки с процентным значением)
DISCOUNT_SUM `double`	Абсолютное значение скидки (если используется тип скидки с абсолютным значением)
TAX_RATE `double`	Ставка налога в процентах
TAX_INCLUDED `char`	Индикатор того, включен ли налог в стоимость Возможные значения: `Y` – налог включен `N` – налог не включен
CUSTOMIZED `char`	Изменен (Устаревшее) Возможные значения: `Y` - Да `N` - Нет
MEASURE_CODE `catalog_measure.code`	Код единицы измерения
MEASURE_NAME `string`	Текстовое представление единицы измерения (например - шт, кг, м, л и т.д.)
SORT `integer`	Сортировка
XML_ID `string`	Внешний код товара
TYPE `integer`	Тип товара Возможные значения: `1` - Простой товар `4` - Торговое предложение/вариация `7` - Услуга
STORE_ID `integer`	Идентификатор склада. Для получения подробной информации о складе используйте `catalog.store.get`
RESERVE_ID `integer`	Идентификатор резерва
DATE_RESERVE_END `date`	Дата окончания резервации
RESERVE_QUANTITY `integer`	Количество зарезервированных единиц товара

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

HTTP-статус: 400

{
          "error": "",
          "error_description": "The parameter id is invalid or not defined."
        }

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

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

Описание	Значение
The parameter id is invalid or not defined	В параметр `id` передано некорректное значение
Access denied	У пользователя нет прав на «чтение» сделки
Not found	Сделка с переданным `id` не найдена

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

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.set

Установить товары в сделку

Обзор событий

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

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

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

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

Тип productrowТип productrow

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

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

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

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