Получить список складов v 3.0 catalog.store.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров» или «Просмотр и выбор склада»
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.store.list возвращает список складов, например все активные склады или только пункты выдачи.
В список попадают склады, которые доступны пользователю по праву «Просмотр и выбор склада». Пользователь с правом «Редактирование складов» также получает склады, которые создал сам.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив полей склада, которые нужно вернуть в ответе. Доступные поля:
Идентификатор По умолчанию: все поля |
|
filter |
Фильтр списка в формате REST 3.0: массив условий вида Фильтровать можно по всем полям, кроме Операторы: |
|
order |
Сортировка в формате Сортировать можно по всем полям, кроме Возможные значения направления:
|
|
pagination |
Параметры постраничной навигации. Описание структуры объекта |
Параметр pagination
|
Название |
Описание |
|
limit |
Количество складов на странице. Значения больше По умолчанию: |
|
page |
Номер страницы, начиная с |
|
offset |
Количество записей, которые нужно пропустить от начала списка. По умолчанию: |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.store.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","title","address","active","issuingCenter"],"filter":[["active","=",true],["issuingCenter","=",true]],"order":{"sort":"asc","id":"desc"},"pagination":{"limit":3}}' \
https://**put_your_bitrix24_address**/rest/api/**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"],"filter":[["active","=",true],["issuingCenter","=",true]],"order":{"sort":"asc","id":"desc"},"pagination":{"limit":3},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.store.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type StoreListResult = {
items: {
id: number
title: string
address: string
active: boolean
issuingCenter: boolean
}[]
}
try {
const response = await $b24.actions.v3.call.make<StoreListResult>({
method: 'catalog.store.list',
params: {
select: ['id', 'title', 'address', 'active', 'issuingCenter'],
filter: [
['active', '=', true],
['issuingCenter', '=', true],
],
order: {
sort: 'asc',
id: 'desc',
},
pagination: {
limit: 3,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
result.items.forEach(store => console.info(store.id, store.title))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listStores() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.store.list',
params: {
select: ['id', 'title', 'address', 'active', 'issuingCenter'],
filter: [
['active', '=', true],
['issuingCenter', '=', true],
],
order: {
sort: 'asc',
id: 'desc',
},
pagination: {
limit: 3,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
result.items.forEach(store => console.info(store.id, store.title))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listStores)
</script>
У методов catalog.store.* REST 3.0 нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через call_method токена клиента с prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "catalog.store.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
bitrix_token = client.get_token()
try:
response = bitrix_token.call_method(
api_method=method,
params={
"select": ["id", "title", "address", "active", "issuingCenter"],
"filter": [
["active", "=", True],
["issuingCenter", "=", True],
],
"order": {
"sort": "asc",
"id": "desc",
},
"pagination": {
"limit": 3,
},
},
prefer_version=3,
)
result = response["result"]
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'catalog.store.list',
[
'select' => ['id', 'title', 'address', 'active', 'issuingCenter'],
'filter' => [
['active', '=', true],
['issuingCenter', '=', true],
],
'order' => [
'sort' => 'asc',
'id' => 'desc',
],
'pagination' => [
'limit' => 3,
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'catalog.store.list',
{
select: ['id', 'title', 'address', 'active', 'issuingCenter'],
filter: [
['active', '=', true],
['issuingCenter', '=', true],
],
order: {
sort: 'asc',
id: 'desc',
},
pagination: {
limit: 3,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.store.list',
[
'select' => ['id', 'title', 'address', 'active', 'issuingCenter'],
'filter' => [
['active', '=', true],
['issuingCenter', '=', true],
],
'order' => [
'sort' => 'asc',
'id' => 'desc',
],
'pagination' => [
'limit' => 3,
],
]
);
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"},
"filter": []any{
[]any{"active", "=", true},
[]any{"issuingCenter", "=", true},
},
"order": b24.Params{
"sort": "asc",
"id": "desc",
},
"pagination": b24.Params{
"limit": 3,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.store.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
Title string `json:"title"`
Address string `json:"address"`
Active bool `json:"active"`
IssuingCenter bool `json:"issuingCenter"`
} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, store := range result.Items {
fmt.Println(store.ID, store.Title)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"id": 13,
"title": "Склад 3",
"active": true,
"address": "Склад 3",
"issuingCenter": true
},
{
"id": 11,
"title": "Склад 2",
"active": true,
"address": "Калининград, улица Баженова, д. 40",
"issuingCenter": true
},
{
"id": 9,
"title": "AliExpress",
"active": true,
"address": "AliExpress",
"issuingCenter": true
}
]
},
"time": {
"start": 1794922633,
"finish": 1794922633.749759,
"duration": 0.7497589588165283,
"processing": 0,
"date_start": "2026-11-17T16:37:13+03:00",
"date_finish": "2026-11-17T16:37:13+03:00",
"operating_reset_at": 1794923220,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.items |
Массив складов на странице. Состав полей зависит от |
|
time |
Информация о времени выполнения запроса |
Общее количество записей метод не возвращает. Если в ответе меньше записей, чем limit, страница последняя.
Элемент items
|
Название |
Описание |
|
id |
Идентификатор склада |
|
title |
Название склада. Пустая строка, если название не задано |
|
active |
Активность склада: |
|
address |
Адрес склада |
|
description |
Описание склада. Пустая строка, если описание не задано |
|
gpsN |
Широта склада. Если координата не задана, приходит |
|
gpsS |
Долгота склада. Если координата не задана, приходит |
|
imageId |
Идентификатор файла изображения склада. |
|
imageUrl |
Ссылка на изображение склада. Пустая строка, если изображения нет |
|
dateModify |
Дата последнего изменения склада |
|
dateCreate |
Дата создания склада. У складов, которые Битрикс24 создал сам, может быть |
|
userId |
Идентификатор пользователя, который создал склад. |
|
modifiedBy |
Идентификатор пользователя, который последним изменил склад |
|
phone |
Телефон склада. Пустая строка, если телефон не задан |
|
schedule |
График работы склада. Пустая строка, если график не задан |
|
xmlId |
Внешний код склада. Пустая строка, если код не задан |
|
sort |
Порядок сортировки склада в списках |
|
email |
E-mail склада. Пустая строка, если адрес не задан |
|
issuingCenter |
Признак пункта выдачи: |
|
code |
Символьный код склада. Пустая строка, если код не задан |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Filter OR groups are not supported"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Filter OR groups are not supported |
Уберите из фильтра группу с логикой |
|
|
Filter NOT groups are not supported |
Уберите из фильтра отрицание. Используйте оператор |
|
|
В DTO |
Уберите поле из |
|
|
В DTO |
Уберите поле из |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Укажите только поля из описания элемента items |
Ошибка формата фильтра
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение фильтра |
Передайте |
Ошибка оператора фильтра
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестный оператор фильтра |
Используйте операторы |
Ошибка сортировки
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение сортировки |
Передайте направление |
Ошибка пагинации
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать параметр пагинации |
Передайте |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
У пользователя нет права «Просмотр каталога товаров» или «Просмотр и выбор склада» |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |