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

Получить складской документ

GET /v1/catalog-documents/:id

Возвращает один складской документ по идентификатору. Подходит, чтобы проверить состояние документа перед изменением, проведением или отменой проведения.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор документа. Список: GET /v1/catalog-documents
select (query) string нет Поля в ответе через запятую: ?select=id,title,status. Имена — из GET /v1/catalog-documents/fields

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-documents/299" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

const { success, data } = await res.json()
console.log('Документ:', data.title, '— проведён:', data.status === 'Y')

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Складской документ (все поля — см. Поля складского документа)
meta.warnings array Предупреждения о запросе. Приходит, когда в select есть имя, которого нет среди полей документа: код UNKNOWN_SELECT_FIELD, имя в поле field. Остальные поля возвращаются

Товары и склады документа в ответ не входят — их возвращает список позиций с filter[docId].

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

JSON 
{
  "success": true,
  "data": {
    "commentary": null,
    "createdBy": 1,
    "currency": "RUB",
    "dateCreate": "2026-10-12T13:20:16.000Z",
    "dateDocument": null,
    "dateModify": "2026-10-12T13:20:16.000Z",
    "dateStatus": "2026-10-12T13:20:16.000Z",
    "docNumber": null,
    "docType": "S",
    "id": 299,
    "modifiedBy": 1,
    "responsibleId": 1,
    "siteId": "s1",
    "status": "N",
    "statusBy": null,
    "title": "Корректировка остатков — проверка документации",
    "total": null
  }
}

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

404 — документа с таким id нет:

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

Ошибки

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

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

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