Добавить товарную позицию в оплату crm.item.payment.product.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом «Изменение» для объекта CRM, к которому относится оплата. Оплата не должна быть оплачена
Метод crm.item.payment.product.add добавляет в оплату товар из товарной строки сделки или счета. Сумма оплаты увеличивается на цену товара, умноженную на quantity.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
paymentId* |
Идентификатор оплаты. Получить идентификаторы оплат объекта CRM можно методом crm.item.payment.list |
|
rowId* |
Идентификатор товарной строки сделки или счета, к которым относится оплата. Получить его можно методом crm.item.productrow.list — поле |
|
quantity* |
Количество товара — целое число от Если товар уже полностью распределен по другим оплатам, метод вернет ошибку |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"paymentId":1039,"rowId":17587,"quantity":2}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.product.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"paymentId":1039,"rowId":17587,"quantity":2,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.payment.product.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'crm.item.payment.product.add',
params: {
paymentId: 1039,
rowId: 17587,
quantity: 2,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Added product row id:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addPaymentProduct() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.payment.product.add',
params: {
paymentId: 1039,
rowId: 17587,
quantity: 2,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Added product row id:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addPaymentProduct)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.product.add(
payment_id=1039,
row_id=17587,
quantity=2,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.item.payment.product.add',
[
'paymentId' => 1039,
'rowId' => 17587,
'quantity' => 2
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding payment product: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.payment.product.add', {
paymentId: 1039,
rowId: 17587,
quantity: 2
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.payment.product.add',
[
'paymentId' => 1039,
'rowId' => 17587,
'quantity' => 2
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.payment.product.add", b24.Params{
"paymentId": 1039,
"rowId": 17587,
"quantity": 2,
})
if err != nil {
return fmt.Errorf("crm.item.payment.product.add: %w", err)
}
var id int
if err := json.Unmarshal(res.Result, &id); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор позиции:", id)
Обработка ответа
HTTP-статус: 200
{
"result":1193,
"time":{
"start":1716276648.349503,
"finish":1716276649.261574,
"duration":0.9120709896087646,
"processing":0.6422691345214844,
"date_start":"2024-05-21T10:30:48+03:00",
"date_finish":"2024-05-21T10:30:49+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданной товарной позиции в оплате. Используйте его в методах crm.item.payment.product.setQuantity и crm.item.payment.product.delete |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Недостаточно товара для добавления в оплату"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Количество товара должно быть больше нуля |
В |
|
|
|
Недостаточно товара для добавления в оплату |
Сумма количеств этого товара во всех оплатах превысит количество в товарной строке объекта CRM |
|
|
|
Товар не найден |
Товарной строки с переданным |
|
|
|
Payment has not been found |
Оплата с переданным |
|
|
|
Access denied |
Оплата уже оплачена или у пользователя нет права на изменение оплаты. Чтобы изменить состав оплаченной оплаты, сначала вызовите crm.item.payment.unpay |
|
|
|
Order binding has not been found |
Заказ оплаты не привязан к объекту CRM |
|
|
|
Entity does not support links with catalog products |
Объект CRM, к которому относится оплата, не поддерживает товары |
|
|
|
Could not find value for parameter { |
Не передан обязательный параметр |
Код 0 метод возвращает для нескольких разных ошибок. Чтобы определить причину, проверяйте текст в error_description.
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |