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

Scope: catalog

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

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

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

Название
тип

Описание

select
array

Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_store)

filter
object

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

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

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

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, не начинающиеся с «мол»
    • "%мол" — ищет значения, не заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (аналогично !=%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

order
object

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

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

Возможные значения для 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","title","active","address","description","gpsN","gpsS","imageId","dateModify","dateCreate","userId","modifiedBy","phone","schedule","xmlId","sort","email","issuingCenter","code"],"filter":{"@userId":[1,2],"<sort":200,"modifiedBy":1},"order":{"id":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.store.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","title","active","address","description","gpsN","gpsS","imageId","dateModify","dateCreate","userId","modifiedBy","phone","schedule","xmlId","sort","email","issuingCenter","code"],"filter":{"@userId":[1,2],"<sort":200,"modifiedBy":1},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.store.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const selectFields = [
            'id',
            'title',
            'active',
            'address',
            'description',
            'gpsN',
            'gpsS',
            'imageId',
            'dateModify',
            'dateCreate',
            'userId',
            'modifiedBy',
            'phone',
            'schedule',
            'xmlId',
            'sort',
            'email',
            'issuingCenter',
            'code',
        ];
        
        try {
            const response = await $b24.callListMethod(
                'catalog.store.list',
                {
                    select: selectFields,
                    filter: {
                        '@userId': [1, 2],
                        '<sort': 200,
                        'modifiedBy': 1,
                    },
                    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: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
            const generator = $b24.fetchListMethod('catalog.store.list', {
                select: selectFields,
                filter: {
                    '@userId': [1, 2],
                    '<sort': 200,
                    'modifiedBy': 1,
                },
                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: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
            const response = await $b24.callMethod('catalog.store.list', {
                select: selectFields,
                filter: {
                    '@userId': [1, 2],
                    '<sort': 200,
                    'modifiedBy': 1,
                },
                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 {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.store.list',
                    [
                        'select' => [
                            'id',
                            'title',
                            'active',
                            'address',
                            'description',
                            'gpsN',
                            'gpsS',
                            'imageId',
                            'dateModify',
                            'dateCreate',
                            'userId',
                            'modifiedBy',
                            'phone',
                            'schedule',
                            'xmlId',
                            'sort',
                            'email',
                            'issuingCenter',
                            'code',
                        ],
                        'filter' => [
                            '@userId'    => [1, 2],
                            '<sort'      => 200,
                            'modifiedBy' => 1,
                        ],
                        'order'  => [
                            'id' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching store list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.store.list',
                {
                    select:[
                        'id',
                        'title',
                        'active',
                        'address',
                        'description',
                        'gpsN',
                        'gpsS',
                        'imageId',
                        'dateModify',
                        'dateCreate',
                        'userId',
                        'modifiedBy',
                        'phone',
                        'schedule',
                        'xmlId',
                        'sort',
                        'email',
                        'issuingCenter',
                        'code',
                    ],
                    filter:{
                        '@userId': [1, 2],
                        '<sort': 200,
                        'modifiedBy': 1,
                    },
                    order:{
                        id: 'desc',
                    },
                },
                function(result)
                {
                    if(result.error()) {
                        console.error(result.error());
                    } else {
                        console.log(result.data());
                    }
                }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.store.list',
            [
                'select' => [
                    'id',
                    'title',
                    'active',
                    'address',
                    'description',
                    'gpsN',
                    'gpsS',
                    'imageId',
                    'dateModify',
                    'dateCreate',
                    'userId',
                    'modifiedBy',
                    'phone',
                    'schedule',
                    'xmlId',
                    'sort',
                    'email',
                    'issuingCenter',
                    'code',
                ],
                'filter' => [
                    '@userId' => [1, 2],
                    '<sort' => 200,
                    'modifiedBy' => 1,
                ],
                'order' => [
                    'id' => 'desc',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": {
                "stores": [
                    {
                        "active": "Y",
                        "address": "пр. Московский д. 52",
                        "code": "store_1",
                        "dateCreate": "2024-10-18T16:30:45+03:00",
                        "dateModify": "2024-10-21T14:29:06+03:00",
                        "description": "Описание",
                        "email": "test@test.ru",
                        "gpsN": 54.71411,
                        "gpsS": 21.56675,
                        "id": 1,
                        "imageId": {
                            "id": 1,
                            "url": "\/upload\/iblock\/6f1\/bkm7jmwso31wisk423gtp28iagy2e8v0\/test.jpeg"
                        },
                        "issuingCenter": "N",
                        "modifiedBy": 1,
                        "phone": "8 (495) 212 85 06",
                        "schedule": "Пн.-Пт. с 9:00 до 20:00, Сб.-Вс. с 11:00 до 18:00",
                        "sort": 100,
                        "title": "Склад 1",
                        "userId": 1,
                        "xmlId": null
                    }
                ]
            },
            "total": 1,
            "time": {
                "start": 1729524388.951684,
                "finish": 1729524389.466658,
                "duration": 0.5149741172790527,
                "processing": 0.04066300392150879,
                "date_start": "2024-10-21T18:26:28+03:00",
                "date_finish": "2024-10-21T18:26:29+03:00",
            }
        }
        

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

Название
тип

Описание

result
object

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

stores
catalog_store[]

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

total
integer

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

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

200040300010

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

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

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

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