crm.item.productrow.list
Получить товарные позиции объекта CRM
Описание
Метод получает товарные позиции объекта CRM.
Параметры
filter
object
обязательный
Объект для фильтрации выбранных записей в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта crm_item_product_row.
Следующие ключи должны обязательно присутствовать:
=ownerType
=ownerId
В =ownerType передавайте Краткий символьный код типа.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
=— равно (работает и с массивами)%— LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки>— больше<— меньше!=— не равно!%— NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.>=— больше либо равно<=— меньше либо равно=%— LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
-"мол%"— ищем значения начинающиеся с «мол»
-"%мол"— ищем значения заканчивающиеся на «мол»
-"%мол%"— ищем значения, где «мол» может быть в любой позиции%=— LIKE (смотрите описание выше)!=%— NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
-"мол%"— ищем значения не начинающиеся с «мол»
-"%мол"— ищем значения не заканчивающиеся на «мол»
-"%мол%"— ищем значения, где подстроки «мол» нет в любой позиции!%=— NOT LIKE (смотрите описание выше)
order
object
необязательный
Объект для сортировки выбранных элементов табличной части отгрузки в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта crm_item_product_row.
Возможные значения для order:
asc— в порядке возрастанияdesc— в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"=ownerType":"D","=ownerId":13142,">price":5000},"order":{"price":"desc"}}' \
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,">price":5000},"order":{"price":"desc"},"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
customized: string
measureCode: number
measureName: string
sort: number
xmlId: string
type: number
storeId: number
}[]
}
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,
'>price': 5000,
},
order: {
price: 'desc',
},
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,
'>price': 5000,
},
order: {
price: 'desc',
},
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,
">price": 5000,
},
order={
"price": "desc",
},
).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.productrow.list(
filter={
"=ownerType": "D",
"=ownerId": 13142,
">price": 5000,
},
order={
"price": "desc",
},
).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}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.productrow.list(
filter={
"=ownerType": "D",
"=ownerId": 13142,
">price": 5000,
},
order={
"price": "desc",
},
).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,
">price" => 5000,
],
'order' => [
'price' => "desc"
],
]
);
$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,
">price": 5000,
},
order: {
price: "desc"
},
},
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,
">price" => 5000,
],
'order' => [
'price' => "desc"
]
]
);
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,
">price": 5000,
},
"order": b24.Params{
"price": "desc",
},
}, 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 int `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.18,
"priceNetto":90909.09,
"priceBrutto":100000,
"quantity":3,
"discountTypeId":2,
"discountRate":10,
"discountSum":9090.91,
"taxRate":10,
"taxIncluded":"Y",
"customized":"Y",
"measureCode":796,
"measureName":"шт",
"sort":20,
"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",
"customized":"Y",
"measureCode":6,
"measureName":"м",
"sort":10,
"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
object
Корневой элемент ответа
productRows
crm_item_product_row[]
Массив объектов, содержащий информацию о выбранных товарных позициях объекта CRM
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":"ACCESS_DENIED",
"error_description":"Доступ запрещен"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Доступ запрещен | |
INVALID_ARG_VALUE |
Некорректные значения входящих параметров | |
100 |
Не переданы обязательные параметры | |
0 |
Другие ошибки (например, фатальные ошибки) |

