При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить список торговых каталогов catalog.catalog.list», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Получить список торговых каталогов catalog.catalog.list

> Scope: catalog
>
> Кто может выполнять метод: администратор

Метод возвращает список торговых каталогов.

Параметры метода

Примеры кода

• cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["iblockId","iblockTypeId","id","lid","name","productIblockId","skuPropertyId","subscription","vatId"],"filter":{">id":10,"@vatId":[1,2],"skuPropertyId":121},"order":{"id":"desc"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.catalog.list

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["iblockId","iblockTypeId","id","lid","name","productIblockId","skuPropertyId","subscription","vatId"],"filter":{">id":10,"@vatId":[1,2],"skuPropertyId":121},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/catalog.catalog.list

• JS

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    const parameters = {
        "select": [
            "iblockId",
            "iblockTypeId",
            "id",
            "lid",
            "name",
            "productIblockId",
            "skuPropertyId",
            "subscription",
            "vatId"
        ],
        "filter": {
            ">id": 10,
            "@vatId": [1, 2],
            "skuPropertyId": 121,
        },
        "order": {
            "id": "desc",
        }
    };
    
    try {
        const response = await $b24.callListMethod(
            'catalog.catalog.list',
            parameters,
            (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 предпочтителен при работе с крупными наборами данных. Метод реализует итеративную выборку с использованием генератора, что позволяет обрабатывать данные по частям и эффективно использовать память.
    
    const parameters = {
        "select": [
            "iblockId",
            "iblockTypeId",
            "id",
            "lid",
            "name",
            "productIblockId",
            "skuPropertyId",
            "subscription",
            "vatId"
        ],
        "filter": {
            ">id": 10,
            "@vatId": [1, 2],
            "skuPropertyId": 121,
        },
        "order": {
            "id": "desc",
        }
    };
    
    try {
        const generator = $b24.fetchListMethod('catalog.catalog.list', parameters, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
        }
    } catch (error) {
        console.error('Request failed', error);
    }
    
    // callMethod предоставляет ручной контроль над процессом постраничного получения данных через параметр start. Подходит для сценариев, где требуется точное управление пакетами запросов. Однако при больших объемах данных может быть менее эффективным по сравнению с fetchListMethod.
    
    const parameters = {
        "select": [
            "iblockId",
            "iblockTypeId",
            "id",
            "lid",
            "name",
            "productIblockId",
            "skuPropertyId",
            "subscription",
            "vatId"
        ],
        "filter": {
            ">id": 10,
            "@vatId": [1, 2],
            "skuPropertyId": 121,
        },
        "order": {
            "id": "desc",
        }
    };
    
    try {
        const response = await $b24.callMethod('catalog.catalog.list', parameters, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity); }
    } catch (error) {
        console.error('Request failed', error);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'catalog.catalog.list',
                [
                    'select' => [
                        'iblockId',
                        'iblockTypeId',
                        'id',
                        'lid',
                        'name',
                        'productIblockId',
                        'skuPropertyId',
                        'subscription',
                        'vatId',
                    ],
                    'filter' => [
                        '>id'          => 10,
                        '@vatId'       => [1, 2],
                        'skuPropertyId' => 121,
                    ],
                    'order' => [
                        'id' => 'desc',
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error fetching catalog list: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        "catalog.catalog.list", {
            "select": [
                "iblockId",
                "iblockTypeId",
                "id",
                "lid",
                "name",
                "productIblockId",
                "skuPropertyId",
                "subscription",
                "vatId"
            ],
            "filter": {
                ">id": 10,
                "@vatId": [1, 2],
                "skuPropertyId": 121,
            },
            "order": {
                "id": "desc",
            }
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'catalog.catalog.list',
        [
            'select' => [
                'iblockId',
                'iblockTypeId',
                'id',
                'lid',
                'name',
                'productIblockId',
                'skuPropertyId',
                'subscription',
                'vatId'
            ],
            'filter' => [
                '>id' => 10,
                '@vatId' => [1, 2],
                'skuPropertyId' => 121,
            ],
            'order' => [
                'id' => 'desc',
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "catalogs": [
            {
                "iblockId": 24,
                "iblockTypeId": 0,
                "id": 24,
                "lid": "s1",
                "name": "Товарный каталог CRM (предложения)",
                "productIblockId": 23,
                "skuPropertyId": 97,
                "subscription": "N",
                "vatId": 1
            }
        ]
    },
    "total": 1,
    "time": {
        "start": 1716796276.902035,
        "finish": 1716796277.31202,
        "duration": 0.4099850654602051,
        "processing": 0.01759815216064453,
        "date_start": "2024-05-27T10:51:16+03:00",
        "date_finish": "2024-05-27T10:51:17+03:00"
    }
}

Возвращаемые данные

Обработка ошибок

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}

Возможные коды ошибок

• [](./catalog-catalog-get)
• [](./catalog-catalog-is-offers)
• [](./catalog-catalog-get-fields)