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

Warehouse fields

GET /v1/warehouses/fields

Returns the warehouse field schema: for each of the 19 fields — its type, a read-only flag, a human-readable label, and a description. Useful for code generation and AI-agent hints.

Warehouses are a custom route (no entity schema), so the field reference is served from a static table and does not call Bitrix24 — the catalog scope is checked, but no Bitrix24 account tokens are required.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/warehouses/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/warehouses/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/warehouses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Warehouse fields:', Object.keys(data.fields))

Response fields

data.fields is an object keyed by field name; each value is { type, readonly, label, description }.

Field Type RO Description
id number yes 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 Warehouse description. null when unset
phone string Contact phone. null when unset
email string Contact email. null when unset
schedule string Working hours. null when unset
sort number Sort order
code string Symbolic code. null when unset
xmlId string External identifier. null when unset
gpsN number Geographic latitude. null when unset
gpsS number Geographic longitude. null when unset
imageId object yes Warehouse image: { id, url } or null
userId number Responsible employee. null on system warehouses
modifiedBy number yes ID of the user who last modified the warehouse. null on system warehouses
dateCreate datetime yes Creation date. null on some system warehouses
dateModify datetime yes Last modification date

The RO fields (readonly: true) — id, imageId, modifiedBy, dateCreate, dateModify — are set by the platform and are not accepted on create or update.

Example response

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Warehouse identifier." },
      "title": { "type": "string", "readonly": false, "label": "Title", "description": "Warehouse name." },
      "active": { "type": "string", "readonly": false, "label": "Active", "description": "Whether the warehouse is active: \"Y\" / \"N\"." }
    }
  }
}

Errors

HTTP Code Description
401 TOKEN_MISSING API key not provided
403 SCOPE_DENIED API key lacks the catalog scope

See Errors for the full list of common API errors.

See also