Update Warehouse catalog.store.update
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 "Edit warehouses" access permission who has access to the warehouse through the "View and select warehouses" access permission, or the warehouse author
The method catalog.store.update updates a warehouse.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Warehouse ID. You can retrieve warehouse IDs using the catalog.store.list method |
|
fields* |
Values of the warehouse fields to update (detailed description). The method updates only the provided fields; the other fields retain their values. The method accepts an empty object |
Parameter fields
|
Name |
Description |
|
address |
Warehouse address. An empty string is not accepted |
|
title |
Warehouse name |
|
active |
Warehouse activity. Possible values:
The method saves any other value as |
|
description |
Warehouse description |
|
gpsN |
Warehouse latitude, for example, The method saves a non-numeric value as |
|
gpsS |
Warehouse longitude, for example, The method saves a non-numeric value as |
|
phone |
Warehouse phone number |
|
schedule |
Warehouse working hours, for example, |
|
email |
Warehouse email. The method does not validate the address format |
|
issuingCenter |
Whether the warehouse is a pickup point. Possible values:
The method saves any other value as |
|
sort |
Sort order of the warehouse in lists. The method saves a non-numeric value as |
|
code |
Warehouse symbolic code |
|
xmlId |
Warehouse external code. Use it to link the warehouse to a record in an external system |
You cannot change the id, userId, modifiedBy, dateCreate, and dateModify fields: the method ignores them without an error. After the update, modifiedBy is the ID of the current user and dateModify is the modification time. The method also ignores unknown fields in fields.
You cannot change or delete the warehouse image imageId with this method: the method rejects an object in imageId, for example, {"fileData": [...]} or {"remove": "Y"}, with the Wrong format of field error, and ignores a string without an error and without changes.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":37,"fields":{"schedule":"Mon-Sun 10:00-22:00","phone":"+49 30 2128 2851","issuingCenter":"N"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.store.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":37,"fields":{"schedule":"Mon-Sun 10:00-22:00","phone":"+49 30 2128 2851","issuingCenter":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.store.update
// 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 StoreUpdateResult = {
store: {
active: string
address: string
code: string | null
dateCreate: ISODate
dateModify: ISODate
description: string | null
email: string | null
gpsN: number | null
gpsS: number | null
id: number
imageId: { id: number; url: string } | null
issuingCenter: string
modifiedBy: number
phone: string | null
schedule: string | null
sort: number | null
title: string | null
userId: number
xmlId: string | null
}
}
try {
const response = await $b24.actions.v2.call.make<StoreUpdateResult>({
method: 'catalog.store.update',
params: {
id: 37,
fields: {
schedule: 'Mon-Sun 10:00-22:00',
phone: '+49 30 2128 2851',
issuingCenter: 'N',
},
},
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('Updated store:', result.store.id, result.store.schedule)
}
} 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 updateStore() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.store.update',
params: {
id: 37,
fields: {
schedule: 'Mon-Sun 10:00-22:00',
phone: '+49 30 2128 2851',
issuingCenter: 'N',
},
},
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('Updated store:', result.store.id, result.store.schedule)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateStore)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.store.update(
bitrix_id=37,
fields={
"schedule": "Mon-Sun 10:00-22:00",
"phone": "+49 30 2128 2851",
"issuingCenter": "N",
},
).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.update',
[
'id' => 37,
'fields' => [
'schedule' => 'Mon-Sun 10:00-22:00',
'phone' => '+49 30 2128 2851',
'issuingCenter' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.store.update',
{
id: 37,
fields: {
schedule: 'Mon-Sun 10:00-22:00',
phone: '+49 30 2128 2851',
issuingCenter: 'N',
},
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.store.update',
[
'id' => 37,
'fields' => [
'schedule' => 'Mon-Sun 10:00-22:00',
'phone' => '+49 30 2128 2851',
'issuingCenter' => 'N',
]
]
);
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.update", b24.Params{
"id": 37,
"fields": b24.Params{
"schedule": "Mon-Sun 10:00-22:00",
"phone": "+49 30 2128 2851",
"issuingCenter": "N",
},
})
if err != nil {
return fmt.Errorf("catalog.store.update: %w", err)
}
// The method wraps the response in an object with the "store" key.
raw, ok := b24.Unwrap(res.Result, "store")
if !ok {
return fmt.Errorf("the response has no store key")
}
// Optional fields can be null, so they use pointers.
var item struct {
ID b24.ID `json:"id"`
Title *string `json:"title"`
Phone *string `json:"phone"`
Schedule *string `json:"schedule"`
IssuingCenter string `json:"issuingCenter"`
ModifiedBy int `json:"modifiedBy"`
DateModify string `json:"dateModify"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parsing the response: %w", err)
}
fmt.Println(item.ID, item.DateModify)
Response Handling
HTTP status: 200
{
"result": {
"store": {
"active": "Y",
"address": "Tiergartenstraße 17, 10785 Berlin, Germany",
"code": "store_kgd",
"dateCreate": "2026-11-05T13:19:57+03:00",
"dateModify": "2026-11-05T13:20:13+03:00",
"description": "Main retail warehouse",
"email": "store-kgd@example.com",
"gpsN": 52.51463,
"gpsS": 13.35011,
"id": 37,
"imageId": null,
"issuingCenter": "N",
"modifiedBy": 1269,
"phone": "+49 30 2128 2851",
"schedule": "Mon-Sun 10:00-22:00",
"sort": 200,
"title": "Tiergarten Warehouse",
"userId": 1269,
"xmlId": "store-kgd-01"
}
},
"time": {
"start": 1793874013,
"finish": 1793874013.076988,
"duration": 0.07698798179626465,
"processing": 0,
"date_start": "2026-11-05T13:20:13+03:00",
"date_finish": "2026-11-05T13:20:13+03:00",
"operating_reset_at": 1793874600,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.store |
An object with all warehouse fields after the update |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "201100000000",
"error_description": "store does not exist."
}
|
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 does not have the "Edit warehouses" access permission or has no access to the warehouse |
|
|
|
store does not exist. |
The warehouse with the specified |
|
|
|
Could not find value for parameter |
The |
|
|
|
Invalid value {abc} to match with parameter {id}. Should be value of type int. |
A non-numeric value is passed in |
|
|
|
Could not find value for parameter |
The |
|
|
|
Invalid value {abc} to match with parameter {fields}. Should be value of type array. |
A value other than an object is passed in |
|
|
|
The warehouse address is not specified |
An empty string is passed in |
|
|
|
Wrong format of field |
An object or an array is passed in the field instead of a value. The text contains the field name, for example, Wrong format of field |
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 |