метод REST scope: catalog

catalog.storeproduct.list

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

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

Описание

Метод 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

Ответ

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"
}
Код Описание Значение
200040300010 Access Denied Недостаточно прав для чтения
0 Другие ошибки

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.