Для AI-агентов: markdown этой страницы — /docs-content/entities/warehouses/fields.md индекс документации — /llms.txt

Поля склада

GET /v1/warehouses/fields

Возвращает схему полей склада: для каждого из 19 полей — тип, признак «только для чтения», человеческое название и описание. Полезно для автогенерации кода и подсказок ИИ-агентам.

Склады — кастомный роут (без сущностной схемы), поэтому справка полей отдаётся из статической таблицы и не обращается к Битрикс24 — скоуп catalog проверяется, но токены портала не требуются.

Примеры

curl — личный ключ

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

curl — OAuth-приложение

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

JavaScript — личный ключ

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

const { success, data } = await res.json()
console.log('Поля склада:', Object.keys(data.fields))

Поля ответа

data.fields — объект, ключ которого — имя поля, а значение — { type, readonly, label, description }.

Поле Тип RO Описание
id number да Идентификатор склада
title string Название склада
address string Адрес склада
active string Активность: "Y" / "N"
issuingCenter string Признак пункта выдачи заказов: "Y" / "N"
description string Описание склада. null, если не задано
phone string Контактный телефон. null, если не задан
email string Контактная почта. null, если не задана
schedule string Режим работы. null, если не задан
sort number Порядок сортировки
code string Символьный код. null, если не задан
xmlId string Внешний идентификатор. null, если не задан
gpsN number Географическая широта. null, если не задана
gpsS number Географическая долгота. null, если не задана
imageId object да Изображение склада: { id, url } или null
userId number Ответственный сотрудник. null у системных складов
modifiedBy number да ID пользователя, изменившего склад последним. null у системных складов
dateCreate datetime да Дата создания. null у части системных складов
dateModify datetime да Дата последнего изменения

Поля с отметкой RO (readonly: true) — id, imageId, modifiedBy, dateCreate, dateModify — заполняются платформой и не принимаются при создании и обновлении.

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Идентификатор", "description": "Идентификатор склада." },
      "title": { "type": "string", "readonly": false, "label": "Название", "description": "Название склада." },
      "active": { "type": "string", "readonly": false, "label": "Активность", "description": "Активность склада: «Y» / «N»." }
    }
  }
}

Ошибки

HTTP Код Описание
401 TOKEN_MISSING API-ключ не передан
403 SCOPE_DENIED API-ключ не имеет скоупа catalog

Полный список общих ошибок API — Ошибки.

Смотрите также