Get Product Rows of the CRM Object crm.item.productrow.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: requires read access permission for the CRM object whose product rows are being selected
DEPRECATED
The development of this method has been halted. Please use the REST 3.0 method crm.<type>.productrow.list.
Retrieves product rows of a CRM object.
If a single row with a known identifier is needed, use the crm.item.productrow.get method. If only the rows with no payment issued are needed, use the crm.item.productrow.getAvailableForPayment method.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
filter* |
Object for filtering selected records in the format |
|
order |
Object for sorting selected product rows in the format Sorting is available by the Without the Possible values for
|
|
start |
This parameter is used for pagination control. The page size of results is always static: 50 records. To select the second page of results, pass the value The formula for calculating the
Pass Default is |
The method does not support the select parameter and always returns the full set of product row fields.
Parameter filter
The =ownerType and =ownerId keys are required — without them the method returns the REQUIRED_ARG_MISSING error.
|
Name |
Description |
|
=ownerType* |
Short symbolic code of the CRM object type: |
|
=ownerId* |
Identifier of the CRM object |
|
Identifier of the product row |
|
|
productId |
Identifier of the product from the catalog |
Filtering is available only by the fields from the table: the other fields of a product row have no index in the database. The method silently ignores conditions on price, productName, quantity, sort, type, and on unknown fields and returns all product rows of the CRM object — check the composition of the selection on your side.
The key may have an additional prefix that specifies the behavior of the filter. Possible prefix values:
=— equals!=— not equal>— greater than>=— greater than or equal to<— less than<=— less than or equal to@— any of the values of an array
The prefixes apply to the id and productId keys. Pass the =ownerType and =ownerId keys with the = prefix only.
The only key that accepts an array of values is @id. For example, {"@id": [17640, 17641]} returns two rows. In the other keys, the method ignores an array in the same way as an unsupported condition.
Write the filter keys in camelCase: =ownerType, not =OWNER_TYPE.
Code Examples
How to Use Examples in Documentation
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>
Example
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 Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Example 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 Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
Example as_list_fast
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
# as_list_fast sets the order and the pagination on its own,
# so order and start do not need to be passed in such a call
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 Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "productRows" key.
raw, ok := b24.Unwrap(res.Result, "productRows")
if !ok {
return fmt.Errorf("no productRows key in the response")
}
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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Response on Success
HTTP status: 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":"VAT 10",
"customized":"Y",
"measureCode":796,
"measureName":"pcs",
"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":"No VAT",
"customized":"Y",
"measureCode":6,
"measureName":"m",
"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"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
next |
Value for the |
|
total |
The total number of records found. It is not returned if |
|
time |
Information about the request execution time |
The result Object
|
Name |
Description |
|
productRows |
Array of objects with information about the selected product rows of the CRM object |
Error Handling
HTTP status: 400
{
"error":"ACCESS_DENIED",
"error_description":"Access denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
The required |
|
|
Access denied. The method returns the same error if the CRM object with the provided |
|
|
Invalid values for input parameters. For example, an array in the value of a filter key with a comparison prefix |
|
|
Required parameters not provided |
|
|
Other errors (e.g., fatal errors) |
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Product Items in CRM Objects: Overview of Methods
- Add Product Row to CRM Object crm.item.productrow.add
- Update the Product Row of a CRM Object crm.item.productrow.update
- Get Information About a Product Item by Id crm.item.productrow.get
- Delete Product Row from CRM Object crm.item.productrow.delete
- Save Product Rows of CRM Object crm.item.productrow.set
- Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment
- Get the List of Fields for Product Rows crm.item.productrow.fields