Получить список остатков по складам по фильтру catalog.storeproduct.list

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров»

Метод catalog.storeproduct.list возвращает список остатков товаров по складам по фильтру.

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

Название
тип

Описание

select
array

Массив со списком полей catalog_storeproduct, которые необходимо выбрать.

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля остатков

filter
object

Объект для фильтрации выбранных остатков товаров по складам в формате {"field_1": "value_1", ..., "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта catalog_storeproduct.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • = — равно, точное совпадение, фильтр по умолчанию
  • != — не равно
  • ! — не равно

order
object

Объект для сортировки выбранных остатков в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта catalog_storeproduct.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","productId","storeId","amount"],"filter":{"productId":6973},"order":{"id":"ASC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.storeproduct.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","productId","storeId","amount"],"filter":{"productId":6973},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.storeproduct.list
        
// callListMethod: Получает все данные сразу.
        // Используйте только для небольших выборок (< 1000 элементов) из-за высокой
        // нагрузки на память.
        
        try {
        const response = await $b24.callListMethod(
            'catalog.storeproduct.list',
            {
            select: [
                'id',
                'productId',
                'storeId',
                'amount'
            ],
            filter: {
                'productId': 6973
            },
            order: {
                'id': 'ASC'
            }
            },
            (progress: number) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора.
        // Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
        const generator = $b24.fetchListMethod('catalog.storeproduct.list', {
            select: [
            'id',
            'productId',
            'storeId',
            'amount'
            ],
            filter: {
            'productId': 6973
            },
            order: {
            'id': 'ASC'
            }
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start.
        // Используйте для точного контроля над пакетами запросов.
        // Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
        const response = await $b24.callMethod('catalog.storeproduct.list', {
            select: [
            'id',
            'productId',
            'storeId',
            'amount'
            ],
            filter: {
            'productId': 6973
            },
            order: {
            'id': 'ASC'
            }
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error: any) {
        console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.storeproduct.list',
                    [
                        'select' => [
                            'id',
                            'productId',
                            'storeId',
                            'amount'
                        ],
                        'filter' => [
                            'productId' => 6973
                        ],
                        'order' => [
                            'id' => 'ASC'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            $result->next();
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching store products: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.storeproduct.list',
            {
                select:[
                    'id',
                    'productId',
                    'storeId',
                    'amount'
                ],
                filter:{
                    'productId': 6973
                },
                order:{
                    'id': 'ASC'
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
                result.next();
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.storeproduct.list',
            [
                'select' => [
                    'id',
                    'productId',
                    'storeId',
                    'amount'
                ],
                'filter' => [
                    'productId' => 6973
                ],
                'order' => [
                    'id' => 'ASC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": {
                "storeProducts": [
                    {
                        "amount": 54,
                        "id": 11,
                        "productId": 6973,
                        "storeId": 1
                    },
                    {
                        "amount": 14,
                        "id": 13,
                        "productId": 6973,
                        "storeId": 11
                    }
                ]
            },
            "total": 2,
            "time": {
                "start": 1758089258.945514,
                "finish": 1758089258.976911,
                "duration": 0.031397104263305664,
                "processing": 0.003245115280151367,
                "date_start": "2025-09-17T09:07:38+03:00",
                "date_finish": "2025-09-17T09:07:38+03:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object

Корневой элемент ответа

storeProducts
catalog_storeproduct[]

Массив объектов с информацией о выбранных остатках товаров по складам, структура зависит от параметра select

total
integer

Общее количество найденных записей

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

200040300010

Access Denied

Недостаточно прав для чтения

0

Другие ошибки

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение