Get a List of Products by Filter catalog.product.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:
catalogWho can execute the method: a user with permission to view the product catalog and permission to read the commercial catalog information block
The method retrieves a list of products from the trade catalog based on a filter.
Method Parameters
|
Name |
Description |
|
select |
An array containing a list of fields that need to be selected (see the catalog_product object fields). Required fields: |
|
filter |
An object for filtering selected products in Possible values for Required fields: A key can be assigned an additional prefix that specifies the filter behavior. Possible prefix values:
For custom fields
Examples of filtering by custom fields: |
|
order |
Object for sorting selected products in Possible values for Possible values for order:
|
|
start |
The parameter is used to control pagination. The results page size is always static — 50 records. To select the second page of results, you need to pass the value — Formula for calculating the
|
Working with product prices
To retrieve product prices, use the catalog.price.* methods.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","iblockId","name","active","available","barcodeMulti","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","quantityReserved","quantityTrace","recurSchemeLength","recurSchemeType","sort","subscribe","timestampX","trialPriceId","type","vatId","vatIncluded","weight","width","withoutOrder","xmlId","property258","property259"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","iblockId","name","active","available","barcodeMulti","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","quantityReserved","quantityTrace","recurSchemeLength","recurSchemeType","sort","subscribe","timestampX","trialPriceId","type","vatId","vatIncluded","weight","width","withoutOrder","xmlId","property258","property259"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CatalogProductFile = {
id: string,
url: string,
urlMachine: string,
}
type CatalogProductProperty = {
value: string,
valueId: string,
}
type CatalogProduct = {
id: number,
iblockId: number,
name: string,
active: string,
available: string,
barcodeMulti: string,
bundle: string,
canBuyZero: string,
code: string,
createdBy: number,
dateActiveFrom: ISODate | null,
dateActiveTo: ISODate | null,
dateCreate: ISODate | null,
detailPicture: CatalogProductFile | null,
detailText: string | null,
detailTextType: string,
height: number,
iblockSectionId: number | null,
length: number,
measure: number | null,
modifiedBy: number,
previewPicture: CatalogProductFile | null,
previewText: string | null,
previewTextType: string,
property258: CatalogProductProperty | null,
property259: CatalogProductProperty[] | null,
purchasingCurrency: string | null,
purchasingPrice: number | null,
quantity: number,
quantityReserved: number,
quantityTrace: string,
recurSchemeLength: number | null,
recurSchemeType: string | null,
sort: number,
subscribe: string | null,
timestampX: ISODate | null,
trialPriceId: number | null,
type: number,
vatId: number | null,
vatIncluded: string | null,
weight: number,
width: number,
withoutOrder: string | null,
xmlId: string | null,
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CatalogProductListResult = {
products: CatalogProduct[],
}
try {
// catalog.product.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<CatalogProductListResult>({
method: 'catalog.product.list',
params: {
select: [
'id',
'iblockId',
'name',
'active',
'available',
'barcodeMulti',
'bundle',
'canBuyZero',
'code',
'createdBy',
'dateActiveFrom',
'dateActiveTo',
'dateCreate',
'detailPicture',
'detailText',
'detailTextType',
'height',
'iblockSectionId',
'length',
'measure',
'modifiedBy',
'previewPicture',
'previewText',
'previewTextType',
'purchasingCurrency',
'purchasingPrice',
'quantity',
'quantityReserved',
'quantityTrace',
'recurSchemeLength',
'recurSchemeType',
'sort',
'subscribe',
'timestampX',
'trialPriceId',
'type',
'vatId',
'vatIncluded',
'weight',
'width',
'withoutOrder',
'xmlId',
'property258',
'property259',
],
filter: {
iblockId: 23,
'>id': 10,
vatId: [1, 2],
},
order: {
id: '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('Products fetched:', result.products.length, result.products)
}
} 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 fetchProductList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.product.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: 'catalog.product.list',
params: {
select: [
'id',
'iblockId',
'name',
'active',
'available',
'barcodeMulti',
'bundle',
'canBuyZero',
'code',
'createdBy',
'dateActiveFrom',
'dateActiveTo',
'dateCreate',
'detailPicture',
'detailText',
'detailTextType',
'height',
'iblockSectionId',
'length',
'measure',
'modifiedBy',
'previewPicture',
'previewText',
'previewTextType',
'purchasingCurrency',
'purchasingPrice',
'quantity',
'quantityReserved',
'quantityTrace',
'recurSchemeLength',
'recurSchemeType',
'sort',
'subscribe',
'timestampX',
'trialPriceId',
'type',
'vatId',
'vatIncluded',
'weight',
'width',
'withoutOrder',
'xmlId',
'property258',
'property259',
],
filter: {
iblockId: 23,
'>id': 10,
vatId: [1, 2],
},
order: {
id: '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('Products fetched:', result.products.length, result.products)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchProductList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.list(
select=[
"id",
"iblockId",
"name",
"active",
"available",
"barcodeMulti",
"bundle",
"canBuyZero",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"height",
"iblockSectionId",
"length",
"measure",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"purchasingCurrency",
"purchasingPrice",
"quantity",
"quantityReserved",
"quantityTrace",
"recurSchemeLength",
"recurSchemeType",
"sort",
"subscribe",
"timestampX",
"trialPriceId",
"type",
"vatId",
"vatIncluded",
"weight",
"width",
"withoutOrder",
"xmlId",
"property258",
"property259",
],
filter={
"iblockId": 23,
">id": 10,
"vatId": [
1,
2,
],
},
order={
"id": "desc",
},
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}")
try {
$select = ['id', 'name', 'price', 'active', 'available', 'dateCreate'];
$filter = ['active' => 'Y'];
$order = ['name' => 'ASC'];
$start = 0;
$result = $serviceBuilder
->getCatalogScope()
->product()
->list($select, $filter, $order, $start);
foreach ($result->getProducts() as $itemResult) {
print("ID: {$itemResult->id}\n");
print("Name: {$itemResult->name}\n");
print("Active: {$itemResult->active}\n");
print("Available: {$itemResult->available}\n");
print("Date Created: {$itemResult->dateCreate->format(DATE_ATOM)}\n");
}
} catch (Throwable $e) {
print("Error: {$e->getMessage()}\n");
}
BX24.callMethod(
"catalog.product.list",
{
"select": [
"id",
"iblockId",
"name",
"active",
"available",
"barcodeMulti",
"bundle",
"canBuyZero",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"height",
"iblockSectionId",
"length",
"measure",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"purchasingCurrency",
"purchasingPrice",
"quantity",
"quantityReserved",
"quantityTrace",
"recurSchemeLength",
"recurSchemeType",
"sort",
"subscribe",
"timestampX",
"trialPriceId",
"type",
"vatId",
"vatIncluded",
"weight",
"width",
"withoutOrder",
"xmlId",
"property258",
"property259",
],
"filter": {
"iblockId": 23,
">id": 10,
"vatId": [1, 2],
},
"order": {
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.list',
[
'select' => [
"id",
"iblockId",
"name",
"active",
"available",
"barcodeMulti",
"bundle",
"canBuyZero",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"height",
"iblockSectionId",
"length",
"measure",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"purchasingCurrency",
"purchasingPrice",
"quantity",
"quantityReserved",
"quantityTrace",
"recurSchemeLength",
"recurSchemeType",
"sort",
"subscribe",
"timestampX",
"trialPriceId",
"type",
"vatId",
"vatIncluded",
"weight",
"width",
"withoutOrder",
"xmlId",
"property258",
"property259",
],
'filter' => [
"iblockId" => 23,
">id" => 10,
"vatId" => [1, 2],
],
'order' => [
"id" => "desc",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.product.list", b24.Params{
"select": []string{"id", "iblockId", "name", "active", "available", "barcodeMulti", "bundle", "canBuyZero", "code", "createdBy", "dateActiveFrom", "dateActiveTo", "dateCreate", "detailPicture", "detailText", "detailTextType", "height", "iblockSectionId", "length", "measure", "modifiedBy", "previewPicture", "previewText", "previewTextType", "purchasingCurrency", "purchasingPrice", "quantity", "quantityReserved", "quantityTrace", "recurSchemeLength", "recurSchemeType", "sort", "subscribe", "timestampX", "trialPriceId", "type", "vatId", "vatIncluded", "weight", "width", "withoutOrder", "xmlId", "property258", "property259"},
"filter": b24.Params{
"iblockId": 23,
">id": 10,
"vatId": []int{1, 2},
},
"order": b24.Params{
"id": "desc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.product.list: %w", err)
}
// The method wraps the response in an object with the "products" key.
raw, ok := b24.Unwrap(res.Result, "products")
if !ok {
return fmt.Errorf("no products key in the response")
}
var items []struct {
Active string `json:"active"`
Available string `json:"available"`
BarcodeMulti string `json:"barcodeMulti"`
Bundle string `json:"bundle"`
CanBuyZero string `json:"canBuyZero"`
Code string `json:"code"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.Active)
}
Response Handling
HTTP status: 200
{
"result": {
"products": [
{
"active": "Y",
"available": "Y",
"barcodeMulti": "Y",
"bundle": "N",
"canBuyZero": "Y",
"code": "Tovar",
"createdBy": 1,
"dateActiveFrom": "2024-05-28T10:00:00+03:00",
"dateActiveTo": "2024-05-29T10:00:00+03:00",
"dateCreate": "2024-05-27T10:00:00+03:00",
"detailPicture": {
"id": "6439",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6439\u0026fields%5BproductId%5D=1243",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6439\u0026fields%5BproductId%5D=1243"
},
"detailText": null,
"detailTextType": "text",
"height": 100,
"iblockId": 23,
"iblockSectionId": 47,
"id": 1243,
"length": 100,
"measure": 5,
"modifiedBy": 1,
"name": "Product",
"previewPicture": {
"id": "6438",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6438\u0026fields%5BproductId%5D=1243",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6438\u0026fields%5BproductId%5D=1243"
},
"previewText": null,
"previewTextType": "text",
"property258": {
"value": "test",
"valueId": "9735"
},
"property259": [
{
"value": "test1",
"valueId": "9736"
},
{
"value": "test2",
"valueId": "9737"
}
],
"purchasingCurrency": "EUR",
"purchasingPrice": 1000,
"quantity": 10,
"quantityReserved": 1,
"quantityTrace": "Y",
"recurSchemeLength": 1,
"recurSchemeType": "D",
"sort": 100,
"subscribe": "Y",
"timestampX": "2024-06-05T10:05:06+03:00",
"trialPriceId": 175,
"type": 1,
"vatId": 1,
"vatIncluded": "Y",
"weight": 100,
"width": 100,
"withoutOrder": "Y",
"xmlId": "1243"
}
]
},
"total": 1,
"time": {
"start": 1717661048.302644,
"finish": 1717661049.079089,
"duration": 0.7764449119567871,
"processing": 0.3525362014770508,
"date_start": "2024-06-06T11:04:08+03:00",
"date_finish": "2024-06-06T11:04:09+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
products |
Array of objects containing information about the selected products |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":200040300010,
"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 |
|
|
Insufficient permissions to read the trade catalog |
|
|
Fields |
|
|
Field |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
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 |