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

Список складов

GET /v1/warehouses

Возвращает список складов портала. Постраничный вывод задаётся параметрами limit и offset.

Параметры

Параметр Тип По умолч. Описание
Параметрlimit Типnumber По умолч.50 ОписаниеКоличество записей (до 5000). При limit > 50 ответ автоматически собирается из нескольких страниц Битрикс24. При limit ≤ 50 лишние записи отсекаются на стороне Vibe (Битрикс24 отдаёт страницу до 50 записей независимо от значения)
Параметрoffset Типnumber По умолч.0 ОписаниеСмещение от начала выборки, построчное: offset=1 начинает со второй записи. При offset ≥ 2500 держите limit ≤ 500

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/warehouses" \
  -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', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Складов: ${meta.total}`)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеМассив складов — состав полей одного склада ниже
Полеmeta.total Типnumber ОписаниеОбщее количество складов на портале
Полеmeta.hasMore Типboolean ОписаниеЕсть ли записи за пределами текущей страницы (offset + длина data < total). Если true — увеличьте limit (до 5000) либо сдвиньте offset

Поля склада

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "Основной склад",
      "address": "г. Москва, ул. Складская, 1",
      "active": "Y",
      "issuingCenter": "N",
      "description": null,
      "phone": null,
      "email": null,
      "schedule": null,
      "sort": 100,
      "code": null,
      "xmlId": null,
      "gpsN": null,
      "gpsS": null,
      "imageId": null,
      "userId": 1,
      "modifiedBy": 1,
      "dateCreate": "2024-01-15T09:00:00+03:00",
      "dateModify": "2024-06-20T14:30:00+03:00"
    },
    {
      "id": 2,
      "title": "Пункт выдачи «Север»",
      "address": "г. Москва, ул. Полярная, 8",
      "active": "Y",
      "issuingCenter": "Y",
      "description": null,
      "phone": "+7 495 000 00 00",
      "email": null,
      "schedule": "Пн–Пт 10:00–20:00",
      "sort": 200,
      "code": "pvz-north",
      "xmlId": null,
      "gpsN": 55.85,
      "gpsS": 37.6,
      "imageId": null,
      "userId": 1,
      "modifiedBy": 1,
      "dateCreate": "2024-03-10T11:00:00+03:00",
      "dateModify": "2024-03-10T11:00:00+03:00"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

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

400 — некорректное значение limit:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "limit must be a positive integer in canonical form — digits only, no leading zero, sign, fraction or exponent"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеlimit не каноническое положительное целое (10.5, 10abc, 1e2, 007 отвергаются) либо offset отрицательный
HTTP400 КодUNSUPPORTED_FILTER Описаниепередан параметр filter[] — эта ручка его не поддерживает и не пересылает в Битрикс24
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа catalog
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен

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

Известные особенности

Только постраничный вывод. Список принимает лишь limit и offset. Фильтрация, сортировка и выборка отдельных полей (filter, sort, select) на этом эндпоинте не поддерживаются — возвращаются все склады портала. Нужный склад отбирайте на стороне клиента по полю из ответа.

Забрать все склады одним запросом. На портале с числом складов больше 50 укажите limit больше реального количества (например, ?limit=5000) — ответ соберётся из нескольких страниц Битрикс24 и вернёт всё разом. Признак неполного ответа — meta.hasMore: true (его же отдаёт ответ по умолчанию limit=50, когда складов больше 50). Сравнивать data.length с meta.total вручную больше не нужно.

offset построчный. Битрикс24 отдаёт склады страницами по 50 и сдвигает выборку только на целую страницу, поэтому Вайбкод запрашивает страницу, накрывающую нужное окно, и отсекает лишние строки с начала. Вам это видно как обычное построчное смещение: offset=1&limit=3 вернёт вторую, третью и четвёртую записи.

Пустой data при hasMore: true — останавливайте обход. Такое бывает, когда запрошенное окно не покрывается одной страницей Битрикс24: в meta.warnings придёт OFFSET_BEYOND_FETCHED_PAGE. Увеличьте limit, чтобы окно уместилось в выборку.

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