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

Поля склада

GET /v1/warehouses/fields

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

Склады обслуживает отдельный обработчик без сущностной схемы, поэтому справка полей отдаётся из статической таблицы и не обращается к Битрикс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))

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

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

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

Поля ответа

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

Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.

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

RO означает readonly: true: поле заполняется платформой и не принимается при создании и обновлении.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {"type": "number", "readonly": true, "label": "Идентификатор", "description": "Идентификатор склада."},
      "title": {"type": "string", "readonly": false, "label": "Название", "description": "Название склада."},
      "address": {"type": "string", "readonly": false, "label": "Адрес", "description": "Адрес склада."},
      "active": {"type": "string", "readonly": false, "label": "Активность", "description": "Активность склада: «Y» / «N»."},
      "issuingCenter": {"type": "string", "readonly": false, "label": "Пункт выдачи", "description": "Признак пункта выдачи заказов: «Y» / «N»."},
      "description": {"type": "string", "readonly": false, "label": "Описание", "description": "Описание склада. null, если не задано."},
      "phone": {"type": "string", "readonly": false, "label": "Телефон", "description": "Контактный телефон. null, если не задан."},
      "email": {"type": "string", "readonly": false, "label": "Электронная почта", "description": "Контактная почта. null, если не задана."},
      "schedule": {"type": "string", "readonly": false, "label": "Режим работы", "description": "Режим работы. null, если не задан."},
      "sort": {"type": "number", "readonly": false, "label": "Сортировка", "description": "Порядок сортировки."},
      "code": {"type": "string", "readonly": false, "label": "Символьный код", "description": "Символьный код. null, если не задан."},
      "xmlId": {"type": "string", "readonly": false, "label": "Внешний идентификатор", "description": "Внешний идентификатор для синхронизации. null, если не задан."},
      "gpsN": {"type": "number", "readonly": false, "label": "Широта", "description": "Географическая широта. null, если не задана."},
      "gpsS": {"type": "number", "readonly": false, "label": "Долгота", "description": "Географическая долгота. null, если не задана."},
      "imageId": {"type": "object", "readonly": true, "label": "Изображение", "description": "Изображение склада: { id, url } или null."},
      "userId": {"type": "number", "readonly": false, "label": "Ответственный", "description": "Ответственный сотрудник — идентификатор из GET /v1/users. null у системных складов."},
      "modifiedBy": {"type": "number", "readonly": true, "label": "Кем изменён", "description": "ID пользователя, изменившего склад последним. null у системных складов."},
      "dateCreate": {"type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата создания. null у части системных складов."},
      "dateModify": {"type": "datetime", "readonly": true, "label": "Дата изменения", "description": "Дата последнего изменения."}
    }
  }
}

Пример ответа при ошибке

401 — не передан API-ключ:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Ошибки

HTTP Код Описание
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа catalog

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

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