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

GET /v1/warehouses

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

#Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей (до 5000). При limit > 50 ответ автоматически собирается из нескольких страниц Битрикс24
offset number 0 Смещение от начала выборки. При 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 Общее количество складов на портале

#Поля склада

Поле Тип Описание
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
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "limit must be a positive integer"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS limit не положительное целое либо offset отрицательный
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

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

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