Получить список товарных позиций оплаты crm.item.payment.product.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом «Чтение» для объекта CRM, к которому относится оплата
Метод crm.item.payment.product.list возвращает список товарных позиций конкретной оплаты.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
paymentId* |
Идентификатор оплаты. |
|
filter |
Объект для фильтрации выбранных товарных позиций оплаты в формате По умолчанию фильтр не применяется. Возможные значения для
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных товарных позиций оплаты в формате По умолчанию записи сортируются по Возможные значения для
Возможные значения для
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"paymentId":1039,"filter":{"\u003E=quantity":2,"@id":[1195,1196]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.product.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"paymentId":1039,"filter":{"\u003E=quantity":2,"@id":[1195,1196]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.payment.product.list
// 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
// Shape of each item returned in result[]
type PaymentProductItem = {
id: number,
paymentId: number,
quantity: number,
entityId?: number,
rowId?: number,
}
try {
const response = await $b24.actions.v2.call.make<PaymentProductItem[]>({
method: 'crm.item.payment.product.list',
params: {
paymentId: 1039,
filter: {
'>=quantity': 2,
'@id': [1195, 1196],
},
},
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('Payment products:', result.length, 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 fetchPaymentProductList() {
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.list',
params: {
paymentId: 1039,
filter: {
'>=quantity': 2,
'@id': [1195, 1196],
},
},
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('Payment products:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchPaymentProductList)
</script>
Пример
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.product.list(
payment_id=1039,
filter={
">=quantity": 2,
"@id": [
1195,
1196,
],
},
).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}")
Пример as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.product.list(
payment_id=1039,
filter={
">=quantity": 2,
"@id": [
1195,
1196,
],
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
Пример as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.product.list(
payment_id=1039,
filter={
">=quantity": 2,
"@id": [
1195,
1196,
],
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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.list',
[
'paymentId' => 1039,
'filter' => [
'>=quantity' => 2,
'@id' => [1195, 1196],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching payment product list: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.payment.product.list', {
paymentId: 1039,
filter: {
">=quantity": 2,
"@id": [1195, 1196],
},
},
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.list',
[
'paymentId' => 1039,
'filter' => [
">=quantity" => 2,
"@id" => [1195, 1196],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.payment.product.list", b24.Params{
"paymentId": 1039,
"filter": b24.Params{
">=quantity": 2,
"@id": []int{1195, 1196},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.payment.product.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
PaymentID b24.ID `json:"paymentId"`
Quantity int `json:"quantity"`
EntityID *b24.ID `json:"entityId"`
RowID *b24.ID `json:"rowId"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.PaymentID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ в случае успеха
HTTP-статус: 200
{
"result":[
{
"id":433,
"paymentId":553,
"quantity":2,
"entityId":1349
}
],
"time":{
"start":1790581835,
"finish":1790581835.956596,
"duration":0.9565958976745605,
"processing":0,
"date_start":"2026-09-28T10:50:35+03:00",
"date_finish":"2026-09-28T10:50:35+03:00",
"operating_reset_at":1790582435,
"operating":0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов, содержащий информацию о выбранных товарных позициях оплаты |
|
time |
Информация о времени выполнения запроса |
Ключ result. Объект типа crm_item_payment_product
|
Название |
Описание |
|
id |
Идентификатор товарной позиции в оплате |
|
paymentId |
Идентификатор оплаты |
|
quantity |
Количество товара |
|
entityId |
Идентификатор товарной позиции заказа. Возвращается, если позиция оплаты не сопоставлена с товарной строкой объекта CRM |
|
rowId |
Идентификатор товарной строки объекта CRM. Возвращается, если позиция оплаты сопоставлена с товарной строкой объекта CRM |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Payment has not been found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Оплата не найдена |
|
|
Доступ запрещен: у пользователя нет права на чтение оплаты |
|
|
Не переданы обязательные поля |
|
|
Другие ошибки (например, фатальные ошибки) |
Особенности обработки ошибок
Для бизнес-ошибок метод может вернуть error: 0. В этом случае ориентируйтесь на error_description и сопоставляйте его со списком ошибок выше.
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |