Получить список складов catalog.store.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров» или «Просмотр и выбор склада»
Метод catalog.store.list возвращает список складов с фильтрацией, сортировкой и постраничной навигацией.
В ответ попадают только склады, доступные пользователю по праву «Просмотр и выбор склада», и склады, которые пользователь создал, если у него есть право «Редактирование складов».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив полей склада, которые нужно вернуть. Доступные поля: Если массив не передан или пустой, метод вернет все поля. Неизвестные поля метод пропускает без ошибки. Имена полей пишите в camelCase: если в |
|
filter |
Объект для фильтрации складов в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
Массив без префикса работает как IN: Неизвестные поля и имена в верхнем регистре, например |
|
order |
Объект для сортировки складов в формате Возможные значения для Возможные значения для
Регистр направления не важен: |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
Если |
Примеры кода
Как использовать примеры в документации
Пример получает активные склады с символьным кодом, который содержит kgd, и сортировкой не меньше 200.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","title","address","active","issuingCenter","sort","code","xmlId"],"filter":{"active":"Y",">=sort":200,"%code":"kgd"},"order":{"sort":"asc","id":"desc"},"start":0}' \
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","address","active","issuingCenter","sort","code","xmlId"],"filter":{"active":"Y",">=sort":200,"%code":"kgd"},"order":{"sort":"asc","id":"desc"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.store.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of one store returned in result.stores (only the selected fields)
type StoreListItem = {
id: number
title: string | null
address: string
active: string
issuingCenter: string
sort: number | null
code: string | null
xmlId: string | null
}
try {
// catalog.store.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<{ stores: StoreListItem[] }>({
method: 'catalog.store.list',
params: {
select: ['id', 'title', 'address', 'active', 'issuingCenter', 'sort', 'code', 'xmlId'],
filter: {
active: 'Y',
'>=sort': 200,
'%code': 'kgd',
},
order: {
sort: 'asc',
id: 'desc',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Stores on page:', result.stores.length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listStores() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.store.list',
params: {
select: ['id', 'title', 'address', 'active', 'issuingCenter', 'sort', 'code', 'xmlId'],
filter: {
active: 'Y',
'>=sort': 200,
'%code': 'kgd',
},
order: {
sort: 'asc',
id: 'desc',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Stores on page:', result.stores.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listStores)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.store.list(
select=["id", "title", "address", "active", "issuingCenter", "sort", "code", "xmlId"],
filter={
"active": "Y",
">=sort": 200,
"%code": "kgd",
},
order={
"sort": "asc",
"id": "desc",
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.store.list',
[
'select' => ['id', 'title', 'address', 'active', 'issuingCenter', 'sort', 'code', 'xmlId'],
'filter' => [
'active' => 'Y',
'>=sort' => 200,
'%code' => 'kgd',
],
'order' => [
'sort' => 'asc',
'id' => 'desc',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.store.list',
{
select: ['id', 'title', 'address', 'active', 'issuingCenter', 'sort', 'code', 'xmlId'],
filter: {
active: 'Y',
'>=sort': 200,
'%code': 'kgd',
},
order: {
sort: 'asc',
id: 'desc',
},
start: 0,
},
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', 'address', 'active', 'issuingCenter', 'sort', 'code', 'xmlId'],
'filter' => [
'active' => 'Y',
'>=sort' => 200,
'%code' => 'kgd',
],
'order' => [
'sort' => 'asc',
'id' => 'desc',
],
'start' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.store.list", b24.Params{
"select": []string{"id", "title", "address", "active", "issuingCenter", "sort", "code", "xmlId"},
"filter": b24.Params{
"active": "Y",
">=sort": 200,
"%code": "kgd",
},
"order": b24.Params{
"sort": "asc",
"id": "desc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.store.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "stores".
raw, ok := b24.Unwrap(res.Result, "stores")
if !ok {
return fmt.Errorf("в ответе нет ключа stores")
}
// Необязательные поля могут прийти как null, поэтому для них указатели.
var items []struct {
ID b24.ID `json:"id"`
Title *string `json:"title"`
Address string `json:"address"`
Active string `json:"active"`
IssuingCenter string `json:"issuingCenter"`
Sort *int `json:"sort"`
Code *string `json:"code"`
XMLID *string `json:"xmlId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Address)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"stores": [
{
"active": "Y",
"address": "Калининград, Московский проспект, 52",
"code": "store_kgd",
"id": 37,
"issuingCenter": "N",
"sort": 200,
"title": "Склад на Московском",
"xmlId": "store-kgd-01"
}
]
},
"total": 1,
"time": {
"start": 1793874021,
"finish": 1793874021.852705,
"duration": 0.8527050018310547,
"processing": 0,
"date_start": "2026-11-05T13:20:21+03:00",
"date_finish": "2026-11-05T13:20:21+03:00",
"operating_reset_at": 1793874600,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
result.stores |
Массив складов. У каждого склада только поля из |
|
total |
Общее количество найденных складов |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "100",
"error_description": "Invalid order \"BAD\""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access Denied |
У пользователя нет ни права «Просмотр каталога товаров», ни права «Просмотр и выбор склада» |
|
|
|
Invalid order "BAD" |
В |
|
|
|
Invalid value {abc} to match with parameter {filter}. Should be value of type array. |
В |
|
|
|
Wrong format value of filter field |
В значении фильтра передан вложенный объект. В тексте указан ключ фильтра |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |