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

Получить позицию складского документа

GET /v1/catalog-document-elements/:id

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

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор позиции. Список позиций документа — GET /v1/catalog-document-elements?filter[docId]=:docId
select (query) string нет Поля в ответе через запятую: ?select=id,elementId,amount. Поле id возвращается всегда. Имена — из GET /v1/catalog-document-elements/fields

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-document-elements/33" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-document-elements/33" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-document-elements/33', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Товар:', data.elementId, 'количество:', data.amount)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор позиции
data.docId number Идентификатор складского документа. Документ — GET /v1/catalog-documents/:id
data.elementId number Идентификатор товара. Товар — GET /v1/catalog-products/:id
data.amount number | null Количество товара, null — не задано
data.purchasingPrice number | null Закупочная цена за единицу, null — не задана
data.storeFrom number | null Склад отправления, null — склад не задан. Склады — GET /v1/warehouses
data.storeTo number | null Склад получения, null — склад не задан. Склады — GET /v1/warehouses

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

JSON 
{
  "success": true,
  "data": {
    "amount": 3,
    "docId": 299,
    "elementId": 6595,
    "id": 33,
    "purchasingPrice": 11000,
    "storeFrom": null,
    "storeTo": 11
  }
}

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

404 — позиция не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "catalogDocumentElement 999999999 not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Позиции с таким id нет, в том числе после удаления её документа
400 INVALID_PARAMS id не является целым неотрицательным числом
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Переданный API-ключ не найден
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
403 SCOPE_DENIED API-ключ не имеет скоупа catalog

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

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