For AI agents: markdown of this page — /docs-content-en/entities/warehouses/update.md documentation index — /llms.txt

Update a warehouse

PATCH /v1/warehouses/:id

Updates a warehouse. Pass only the editable fields — flat at the root of the JSON. The fields you pass replace the current values; the rest remain unchanged.

Path parameters

Parameter Type Description
id number Warehouse identifier

Request fields (body)

Any subset of the warehouse's editable fields — all optional.

Parameter Type Description
title string Warehouse name
address string Warehouse address
active string Active flag: "Y" / "N"
issuingCenter string Order pickup point: "Y" / "N"
description string Warehouse description
phone string Contact phone
email string Contact email
schedule string Working hours
sort number Sort order
code string Symbolic code
xmlId string External identifier
gpsN number Geographic latitude
gpsS number Geographic longitude
userId number Responsible employee

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/warehouses/1" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Central warehouse",
    "sort": 50
  }'

curl — OAuth application

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/warehouses/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Central warehouse",
    "sort": 50
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/warehouses/1', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Central warehouse',
    sort: 50,
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/warehouses/1', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Central warehouse',
    sort: 50,
  }),
})

const { success, data } = await res.json()

Response fields

The updated warehouse object is returned in the data field.

Field Type Description
id number Warehouse identifier
title string Warehouse name
address string Warehouse address
active string Active flag: "Y" / "N"
issuingCenter string Order pickup point flag: "Y" / "N"
description string | null Warehouse description. null if not set
phone string | null Contact phone. null if not set
email string | null Contact email. null if not set
schedule string | null Working hours. null if not set
sort number Sort order
code string | null Symbolic code. null if not set
xmlId string | null External identifier. null if not set
gpsN number | null Geographic latitude. null if not set
gpsS number | null Geographic longitude. null if not set
imageId object | null Warehouse image: { "id", "url" } or null
userId number | null Responsible employee. null for system warehouses
modifiedBy number Identifier of the user who last modified the warehouse. After an update — the user the API key was issued for
dateCreate datetime | null Creation date. null for some system warehouses, for example marketplaces
dateModify datetime Last modification date

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "title": "Central warehouse",
    "address": "1 Harbour Street, Amsterdam",
    "active": "Y",
    "issuingCenter": "N",
    "description": "Central warehouse",
    "phone": "+12025550123",
    "email": "warehouse@example.com",
    "schedule": "Mon–Fri 9:00–20:00",
    "sort": 50,
    "code": "main",
    "xmlId": null,
    "gpsN": 52.377956,
    "gpsS": 4.897070,
    "imageId": null,
    "userId": 1,
    "modifiedBy": 1,
    "dateCreate": "2024-01-15T09:00:00+00:00",
    "dateModify": "2026-06-02T12:04:25+00:00"
  }
}

Error response example

422 — a warehouse with this id does not exist:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "store does not exist."
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS id is not a positive integer
401 TOKEN_MISSING The API key has no configured tokens
403 SCOPE_DENIED The API key does not have the catalog scope
422 BITRIX_ERROR A warehouse with the specified id does not exist

The full list of common API errors — Errors.

Known specifics

A nonexistent warehouse is 422, not 404. Updating a warehouse by an unknown id returns 422 with code BITRIX_ERROR. Before updating, check that the warehouse exists in the list of warehouses.

See also