Получить список складов по фильтру catalog.store.list
Scope:
catalogКто может выполнять метод: администратор
Метод возвращает список складов по фильтру.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_store) |
|
filter |
Объект для фильтрации выбранных складов в формате Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных складов в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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 |
Корневой элемент ответа |
|
stores |
Массив объектов с информацией о выбранных складах |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить склад catalog.store.add
- Изменить склад catalog.store.update
- Получить значения полей склада catalog.store.get
- Удалить склад catalog.store.delete
- Получить доступные поля склада catalog.store.getFields