Get a list of products by filter catalog.product.list

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: catalog

Who can execute the method: administrator

The method retrieves a list of products from the trade catalog based on a filter.

Method Parameters

Name
type

Description

select
array

An array containing a list of fields that need to be selected (see the catalog_product object fields).

Required fields: id, iblockId

filter
object

An object for filtering selected products in {"field_1": "value_1", ... "field_N": "value_N"} format.

Possible values for field correspond to the fields of the catalog_product object.

Required fields: iblockId.

A key can be assigned an additional prefix that clarifies the filter's behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • % — LIKE, substring search. The % symbol does not need to be passed in the filter value. The search finds the substring in any position of the string.
  • =% — LIKE, substring search. The % symbol must be passed in the value. Examples:
    • "mol%" — searching for values starting with "mol"
    • "%mol" — searching for values ending with "mol"
    • "%mol%" — searching for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • !% — NOT LIKE, substring search. The % symbol does not need to be passed in the filter value. The search goes from both sides.
  • !=% — NOT LIKE, substring search. The % symbol must be passed in the value. Examples:
    • "mol%" — searching for values not starting with "mol"
    • "%mol" — searching for values not ending with "mol"
    • "%mol%" — searching for values where the "mol" substring is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equal, exact match (used by default). For IN search, you can pass multiple values as an array
  • != — not equal
  • ! — not equal. For NOT IN search, you can pass multiple values as an array

For propertyN properties, the value format in filter depends on the condition type:

  • if filtering a date or date-time type property by range, use the prefix in the key and pass the value in the value field
  • if filtering a numeric, string, or list property by exact match, pass the value directly, without value
  • for IN and NOT IN search, you can pass an array of values

Examples of filtering by properties:

filter: {
            iblockId: 23,
            '>=property424': {
                value: '2025-05-29T12:00:00+03:00' 
            },
            '<=property424': {
                value: '2025-05-30T13:00:00+03:00'
            },
            property996: 9636,
            property997: [9636, 568, 570, 9658],
        }

order
object

Object for sorting selected products in {"field_1": "order_1", ... "field_N": "order_N"} format.

Possible values for field correspond to the fields of the catalog_product object.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

start
string

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 — 50. To select the third page of results, the value is — 100 and so on.

Formula for calculating the start parameter value:

start = (N-1) * 50, where N — the required page number

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>
        
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>';

Response Handling

HTTP status: 200

{
            "result": {
                "products": [
                    {
                        "active": "Y",
                        "available": "Y",
                        "barcodeMulti": "Y",
                        "bundle": "N",
                        "canBuyZero": "Y",
                        "code": "Product",
                        "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": "USD",
                        "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
type

Description

result
object

Root response item

products
catalog_product[]

Array of objects containing information about the selected products

total
integer

Total number of records found

time
time

Request execution time information

Error Handling

HTTP status: 400

{
            "error":200040300010,
            "error_description":"Access denied"
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

200040300010

Insufficient permissions to read the trade catalog

0

Fields id, iblockId are not specified in the selection fields

0

Field iblockId is not specified in the filter

0

Other errors (e.g., fatal errors)

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site 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

Previous
Get product by id
Next
Download product files