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

Scope: catalog

Who can execute the method: administrator

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

Method Parameters

Name
type

Description

select
array

An array containing the list of fields to select (see fields of the catalog_product object).

Required fields: id, iblockId

filter
object

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

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

Required fields: iblockId.

An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string.
  • =% — LIKE, substring search. The % symbol needs to 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 in the filter value does not need to be passed. The search goes from both sides.
  • !=% — NOT LIKE, substring search. The % symbol needs to 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 substring "mol" is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equal, exact match (used by default). For IN search, multiple values can be passed as an array
  • != — not equal
  • ! — not equal. For NOT IN search, multiple values can be passed as an array

order
object

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

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

This parameter is used to control pagination.

The page size of results 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 — 100, and so on.

The formula for calculating the start parameter value:

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

Working with product price

To get product prices, use the methods catalog.price.*.

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
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            '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",
              }
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('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",
            }
          }, 'id');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.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",
            }
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', 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>';

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+02:00",
                        "dateActiveTo": "2024-05-29T10:00:00+02:00",
                        "dateCreate": "2024-05-27T10:00:00+02: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+02: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+02:00",
                "date_finish": "2024-06-06T11:04:09+02:00"
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response

products
catalog_product[]

Array of objects with information about the selected products

total
integer

Total number of records found

time
time

Information about the request execution time

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 rights to read the trade catalog

0

Fields id, iblockId not specified in the selection fields

0

Field iblockId 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 allowed to be called 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 methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users

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 option "Temporary closure of the public part of the site". 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