Get a list of inventories by filter 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: catalog

Who can execute the method: administrator

The method returns a list of inventories based on the filter.

Method Parameters

Name
type

Description

select
array

An array of fields to select (see fields of the catalog_store object)

filter
object

An object for filtering selected inventories in the format {"field_1": "value_1", ..., "field_N": "value_N"}.

Possible values for field correspond to the fields of the catalog_store object.

An additional prefix can be specified for the key to clarify the filter's behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides
  • !=% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values not starting with "mol"
    • "%mol" — searches for values not ending with "mol"
    • "%mol%" — searches for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

order
object

An object for sorting selected inventories in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to the fields of the catalog_store object.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

start
integer

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 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the number of the desired page

Code Examples

How to Use Examples in Documentation

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 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',
                            '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 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", "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)
        }
        
        // The method wraps the response in an object with the "stores" key.
        raw, ok := b24.Unwrap(res.Result, "stores")
        if !ok {
        	return fmt.Errorf("no stores key in the response")
        }
        
        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("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.Active)
        }

Response Handling

HTTP status: 200

{
            "result": {
                "stores": [
                    {
                        "active": "Y",
                        "address": "Main St. 52",
                        "code": "store_1",
                        "dateCreate": "2024-10-18T16:30:45+02:00",
                        "dateModify": "2024-10-21T14:29:06+02:00",
                        "description": "Description",
                        "email": "test@test.com",
                        "gpsN": 54.71411,
                        "gpsS": 21.56675,
                        "id": 1,
                        "imageId": {
                            "id": 1,
                            "url": "\/upload\/iblock\/6f1\/bkm7jmwso31wisk423gtp28iagy2e8v0\/test.jpeg"
                        },
                        "issuingCenter": "N",
                        "modifiedBy": 1,
                        "phone": "+1 (495) 212 85 06",
                        "schedule": "Mon.-Fri. from 9:00 to 20:00, Sat.-Sun. from 11:00 to 18:00",
                        "sort": 100,
                        "title": "Warehouse 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+02:00",
                "date_finish": "2024-10-21T18:26:29+02:00"
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response

stores
catalog_store[]

An array of objects with information about the selected inventories

total
integer

Total number of records found

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error":200040300010,
            "error_description":"Access denied"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

200040300010

Insufficient rights for reading

0

Other errors (e.g., fatal errors)

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning

Previous
Get Warehouse Field Values
Next
Delete Warehouse