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

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

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"
  }
}

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

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

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не каноническое положительное целое: 12.5, 12abc, 1e2, 007 отвергаются до обращения к Битрикс24
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа catalog
HTTP404 КодENTITY_NOT_FOUND ОписаниеСклад с указанным id не существует

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

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

Несуществующий склад — 404. Запрос склада по неизвестному id возвращает 404 с кодом ENTITY_NOT_FOUND — так же, как товары и цены каталога. В поле message остаётся текст портала store does not exist..

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

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