метод REST scope: crm Устаревший

crm.deal.productrows.set

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

Устаревший метод. Развитие метода остановлено. Используйте 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 -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

Ответ

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>"
}
Код Описание Значение
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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.