Get a List of Warehouses catalog.store.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with the "View product catalog" or "View and select warehouses" access permission
The method catalog.store.list returns a list of warehouses with filtering, sorting, and pagination.
The response includes only the warehouses available to the user through the "View and select warehouses" access permission, and the warehouses the user created if they have the "Edit warehouses" access permission.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
An array of warehouse fields to return. Available fields: If the array is not provided or is empty, the method returns all fields. The method ignores unknown fields without an error. Write field names in camelCase: if |
|
filter |
An object for filtering warehouses in the format Possible values for An additional prefix can be specified for the key to clarify the filter's behavior. Possible prefix values:
An array without a prefix works as IN: The method ignores unknown fields and uppercase names, for example, |
|
order |
An object for sorting warehouses in the format Possible values for Possible values for
The direction is case-insensitive: |
|
start |
This parameter is used for managing pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value The formula for calculating the
If |
Code Examples
How to Use Examples in Documentation
The example retrieves active warehouses whose symbolic code contains kgd and whose sort order is at least 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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "stores" key.
raw, ok := b24.Unwrap(res.Result, "stores")
if !ok {
return fmt.Errorf("the response has no stores key")
}
// Optional fields can be null, so they use pointers.
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("parsing the response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Address)
}
Response Handling
HTTP status: 200
{
"result": {
"stores": [
{
"active": "Y",
"address": "Tiergartenstraße 17, 10785 Berlin, Germany",
"code": "store_kgd",
"id": 37,
"issuingCenter": "N",
"sort": 200,
"title": "Tiergarten Warehouse",
"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
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.stores |
An array of warehouses. Each warehouse contains only the fields from |
|
total |
The total number of warehouses found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "100",
"error_description": "Invalid order \"BAD\""
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access Denied |
The user has neither the "View product catalog" nor the "View and select warehouses" access permission |
|
|
|
Invalid order "BAD" |
A direction other than |
|
|
|
Invalid value {abc} to match with parameter {filter}. Should be value of type array. |
A value other than an object is passed in |
|
|
|
Wrong format value of filter field |
A nested object is passed in the filter value. The text contains the filter key |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |