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
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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type StoreResult = {
id: number
title: string
active: string
address: string
description: string
gpsN: number
gpsS: number
imageId: { id: number; url: string } | null
dateModify: ISODate | null
dateCreate: ISODate | null
userId: number
modifiedBy: number
phone: string
schedule: string
xmlId: string | null
sort: number
email: string
issuingCenter: string
code: 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: StoreResult[] }>({
method: 'catalog.store.list',
params: {
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',
},
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 count:', result.stores.length, 'First store:', result.stores[0])
}
} 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 getStoreList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// 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({
method: 'catalog.store.list',
params: {
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',
},
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 count:', result.stores.length, 'First store:', result.stores[0])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStoreList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.store.list(
select=[
"id",
"title",
"active",
"address",
"phone",
"xmlId",
],
filter={
"active": "Y",
},
order={
"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',
'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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.store.list", b24.Params{
"select": []string{"id", "title", "active", "address", "description", "gpsN", "gpsS", "imageId", "dateModify", "dateCreate", "userId", "modifiedBy", "phone", "schedule", "xmlId", "sort", "email", "issuingCenter", "code"},
"filter": b24.Params{
"@userId": []int{1, 2},
"<sort": 200,
"modifiedBy": 1,
},
"order": b24.Params{
"id": "desc",
},
}, 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")
}
var items []struct {
Active string `json:"active"`
Address string `json:"address"`
Code string `json:"code"`
DateCreate string `json:"dateCreate"`
DateModify string `json:"dateModify"`
Description string `json:"description"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Active)
}
Ответ
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 |
Другие ошибки (например, фатальные ошибки) |

