#Получить склад

GET /v1/warehouses/:id

Возвращает один склад по идентификатору со всеми полями.

#Параметры пути

Параметр Тип Описание
id number Идентификатор склада

#Примеры

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

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

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

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

const { success, data } = await res.json()
console.log(data.title)

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

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

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект склада — состав полей ниже

#Поля склада

Поле Тип Описание
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": "Центральный склад",
    "phone": "+7 495 000 00 00",
    "email": "warehouse@example.com",
    "schedule": "Пн–Пт 9:00–20:00",
    "sort": 100,
    "code": "main",
    "xmlId": null,
    "gpsN": 55.751244,
    "gpsS": 37.618423,
    "imageId": {
      "id": 57,
      "url": "https://cdn.bitrix24.ru/b00000000/catalog/store.png"
    },
    "userId": 1,
    "modifiedBy": 1,
    "dateCreate": "2024-01-15T09:00:00+03:00",
    "dateModify": "2024-06-20T14:30:00+03:00"
  }
}

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

422 — склад с таким id не существует:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "store does not exist."
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не положительное целое
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
422 BITRIX_ERROR Склад с указанным id не существует

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

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

Несуществующий склад — 422, не 404. Запрос склада по неизвестному id возвращает 422 с кодом BITRIX_ERROR. Перед получением проверяйте наличие склада в списке складов.

Изображение склада. Поле imageId приходит объектом { "id", "url" } со ссылкой на картинку склада либо null, если изображение не задано.

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