Получить товарные позиции объекта CRM crm.item.productrow.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: требуется право на чтение объекта CRM, товарные позиции которого выбираются
Метод crm.item.productrow.list получает товарные позиции объекта CRM.
Если нужна одна позиция с известным идентификатором, используйте метод crm.item.productrow.get. Если нужны только позиции без выставленной оплаты — метод crm.item.productrow.getAvailableForPayment.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Объект для фильтрации выбранных записей в формате |
|
order |
Объект для сортировки выбранных товарных позиций в формате Сортировать можно по полям Без параметра Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
Передайте По умолчанию — |
Метод не поддерживает параметр select и всегда возвращает полный набор полей товарной позиции.
Параметр filter
Ключи =ownerType и =ownerId обязательны — без них метод вернет ошибку REQUIRED_ARG_MISSING.
|
Название |
Описание |
|
=ownerType* |
Краткий символьный код типа объекта CRM: |
|
=ownerId* |
Идентификатор объекта CRM |
|
Идентификатор товарной позиции |
|
|
productId |
Идентификатор товара из каталога |
Фильтровать можно только по полям из таблицы: у остальных полей товарной позиции нет индекса в базе. Условия по price, productName, quantity, sort, type и по неизвестным полям метод молча игнорирует и возвращает все позиции объекта CRM — проверяйте состав выборки на своей стороне.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
=— равно!=— не равно>— больше>=— больше либо равно<— меньше<=— меньше либо равно@— любое из значений массива
Префиксы применимы к ключам id и productId. Ключи =ownerType и =ownerId передавайте только с префиксом =.
Единственный ключ, который принимает массив значений, — @id. Например, {"@id": [17640, 17641]} вернет две позиции. В остальных ключах массив метод игнорирует так же, как неподдерживаемое условие.
Ключи фильтра пишите в camelCase: =ownerType, а не =OWNER_TYPE.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"=ownerType":"D","=ownerId":13142,">id":17640},"order":{"sort":"asc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"=ownerType":"D","=ownerId":13142,">id":17640},"order":{"sort":"asc"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.productrow.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 the payload returned in result (match the "response handling" section of the page)
type ProductRowListResult = {
productRows: {
id: number
ownerId: number
ownerType: string
productId: number
productName: string
price: number
priceAccount: number
priceExclusive: number
priceNetto: number
priceBrutto: number
quantity: number
discountTypeId: number
discountRate: number
discountSum: number
taxRate: number | null
taxIncluded: string
taxName: string
customized: string
measureCode: number
measureName: string
sort: number
xmlId: string
type: number
storeId: number | null
}[]
}
try {
// crm.item.productrow.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<ProductRowListResult>({
method: 'crm.item.productrow.list',
params: {
filter: {
'=ownerType': 'D',
'=ownerId': 13142,
'>id': 17640,
},
order: {
sort: 'asc',
},
start: 0,
},
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(result.productRows.length, result.productRows)
}
} 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 listProductRows() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.item.productrow.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.item.productrow.list',
params: {
filter: {
'=ownerType': 'D',
'=ownerId': 13142,
'>id': 17640,
},
order: {
sort: 'asc',
},
start: 0,
},
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(result.productRows.length, result.productRows)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listProductRows)
</script>
Пример
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.productrow.list(
filter={
"=ownerType": "D",
"=ownerId": 13142,
">id": 17640,
},
order={
"sort": "asc",
},
start=0,
).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.productrow.list(
filter={
"=ownerType": "D",
"=ownerId": 13142,
">id": 17640,
},
order={
"sort": "asc",
},
start=0,
).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:
# as_list_fast задает порядок и постраничную навигацию сам,
# поэтому order и start в таком вызове передавать не нужно
bitrix_response = client.crm.item.productrow.list(
filter={
"=ownerType": "D",
"=ownerId": 13142,
},
).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.productrow.list',
[
'filter' => [
"=ownerType" => 'D',
"=ownerId" => 13142,
">id" => 17640,
],
'order' => [
'sort' => "asc"
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing product rows: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.productrow.list', {
filter: {
"=ownerType": 'D',
"=ownerId": 13142,
">id": 17640,
},
order: {
sort: "asc"
},
start: 0,
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.productrow.list',
[
'filter' => [
"=ownerType" => 'D',
"=ownerId" => 13142,
">id" => 17640,
],
'order' => [
'sort' => "asc"
],
'start' => 0
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.productrow.list", b24.Params{
"filter": b24.Params{
"=ownerType": "D",
"=ownerId": 13142,
">id": 17640,
},
"order": b24.Params{
"sort": "asc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.productrow.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "productRows".
raw, ok := b24.Unwrap(res.Result, "productRows")
if !ok {
return fmt.Errorf("в ответе нет ключа productRows")
}
var items []struct {
ID b24.ID `json:"id"`
OwnerID b24.ID `json:"ownerId"`
OwnerType string `json:"ownerType"`
ProductID b24.ID `json:"productId"`
ProductName string `json:"productName"`
Price float64 `json:"price"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Ответ в случае успеха
HTTP-статус: 200
{
"result":{
"productRows":[
{
"id":17649,
"ownerId":13142,
"ownerType":"D",
"productId":9621,
"productName":"iphone 14",
"price":90000,
"priceAccount":90000,
"priceExclusive":81818.18181818,
"priceNetto":90909.09090909,
"priceBrutto":100000,
"quantity":3,
"discountTypeId":2,
"discountRate":10,
"discountSum":9090.90909091,
"taxRate":10,
"taxIncluded":"Y",
"taxName":"НДС 10",
"customized":"Y",
"measureCode":796,
"measureName":"шт",
"sort":10,
"xmlId":"sale_basket_8147",
"type":4,
"storeId":19
},
{
"id":17650,
"ownerId":13142,
"ownerType":"D",
"productId":9623,
"productName":"iphone 10xs",
"price":5550,
"priceAccount":5550,
"priceExclusive":5550,
"priceNetto":5550,
"priceBrutto":5550,
"quantity":1,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"Y",
"taxName":"Без НДС",
"customized":"Y",
"measureCode":6,
"measureName":"м",
"sort":20,
"xmlId":"sale_basket_8148",
"type":4,
"storeId":17
}
]
},
"total":2,
"time":{
"start":1716905609.186602,
"finish":1716905609.434087,
"duration":0.24748492240905762,
"processing":0.06894516944885254,
"date_start":"2024-05-28T17:13:29+03:00",
"date_finish":"2024-05-28T17:13:29+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
next |
Значение для параметра |
|
total |
Общее количество найденных записей. Не возвращается, если передан |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
productRows |
Массив объектов с информацией о выбранных товарных позициях объекта CRM |
Обработка ошибок
HTTP-статус: 400
{
"error":"ACCESS_DENIED",
"error_description":"Доступ запрещен"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
В фильтре нет обязательного ключа |
|
|
Доступ запрещен. Эту же ошибку метод вернет, если объекта CRM с переданным |
|
|
Некорректные значения входящих параметров. Например, массив в значении ключа фильтра с префиксом сравнения |
|
|
Не переданы обязательные параметры |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Товарные позиции в объектах CRM: обзор методов
- Добавить товарную позицию в объект CRM crm.item.productrow.add
- Изменить товарную позицию объекта CRM crm.item.productrow.update
- Получить информацию о товарной позиции по id crm.item.productrow.get
- Удалить товарную позицию из объекта CRM crm.item.productrow.delete
- Сохранить товарные позиции объекта CRM crm.item.productrow.set
- Получить неоплаченные товарные позиции объекта CRM crm.item.productrow.getAvailableForPayment
- Получить список полей товарных позиций crm.item.productrow.fields