Get a list of inventories by filter catalog.store.list
Scope:
catalogWho can execute the method: administrator
The method returns a list of inventories based on the filter.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to select (see fields of the catalog_store object) |
|
filter |
An object for filtering selected inventories in the format Possible values for An additional prefix can be specified for the key to clarify the filter's behavior. Possible prefix values:
|
|
order |
An object for sorting selected inventories in the format Possible values for Possible values for
|
|
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
|
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
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
const selectFields = [
'id',
'title',
'active',
'address',
'description',
'gpsN',
'gpsS',
'imageId',
'dateModify',
'dateCreate',
'userId',
'modifiedBy',
'phone',
'schedule',
'xmlId',
'sort',
'email',
'issuingCenter',
'code',
];
try {
const response = await $b24.callListMethod(
'catalog.store.list',
{
select: selectFields,
filter: {
'@userId': [1, 2],
'<sort': 200,
'modifiedBy': 1,
},
order: {
id: 'desc',
},
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('catalog.store.list', {
select: selectFields,
filter: {
'@userId': [1, 2],
'<sort': 200,
'modifiedBy': 1,
},
order: {
id: 'desc',
},
}, 'id');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('catalog.store.list', {
select: selectFields,
filter: {
'@userId': [1, 2],
'<sort': 200,
'modifiedBy': 1,
},
order: {
id: 'desc',
},
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', 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>';
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 |
Description |
|
result |
Root element of the response |
|
stores |
An array of objects with information about the selected inventories |
|
total |
Total number of records found |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error":200040300010,
"error_description":"Access denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient rights for reading |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Inventory catalog.store.add
- Update Warehouse catalog.store.update
- Get Store Field Values catalog.store.get
- Delete warehouse catalog.store.delete
- Get Available Store Fields catalog.store.getFields