метод REST scope: catalog

catalog.store.list

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

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

Описание

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

Параметры

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

Ответ

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

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

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