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

Строка остатка склада

GET /v1/warehouses/:id/stock/:recordId

Читает одну строку остатка склада. Её идентификатор отличается от идентификаторов товара и склада. Нужен скоуп catalog. Ключ только для чтения подходит.

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

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеИдентификатор склада из списка складов, каноническое положительное безопасное целое
ПараметрrecordId (path) Типnumber Обяз.да ОписаниеИдентификатор строки из списка остатков, каноническое положительное безопасное целое

Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Остаток:', data.amount)

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

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

const { success, data } = await res.json()
console.log('Остаток:', data.amount)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеСтрока остатка склада из списка остатков — состав полей ниже
Полеdata.id Типnumber ОписаниеИдентификатор строки из списка остатков
Полеdata.productId Типnumber ОписаниеИдентификатор товара из списка товаров каталога
Полеdata.storeId Типnumber ОписаниеИдентификатор склада из списка складов
Полеdata.amount Типnumber | null ОписаниеОстаток
Полеdata.quantityReserved Типnumber | null ОписаниеРезерв, может превышать остаток

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

JSON 
{
  "success": true,
  "data": {
    "id": 3,
    "productId": 6595,
    "storeId": 1,
    "amount": 15,
    "quantityReserved": 30
  }
}

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

404 — строка остатка не найдена на указанном складе:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Warehouse stock record not found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный id или recordId, отказ до вызова Битрикс24
HTTP401 КодTOKEN_MISSING ОписаниеТокены не настроены
HTTP403 КодSCOPE_DENIED ОписаниеНет скоупа catalog
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 явно отказал в доступе к методу
HTTP404 КодENTITY_NOT_FOUND ОписаниеСтрока отсутствует, недоступна или принадлежит другому складу
HTTP422 КодBITRIX_ERROR ОписаниеБизнес-отказ Битрикс24
HTTP429 КодQUEUE_OVERFLOW ОписаниеОчередь вызовов переполнена
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен
HTTP503 КодBITRIX_TIMEOUT ОписаниеТаймаут Битрикс24

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

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