For AI agents: markdown of this page — /docs-content-en/entities/catalog-documents/get.md documentation index — /llms.txt

Get an inventory document

GET /v1/catalog-documents/:id

Returns one inventory document by ID. Use it to check the document state before changing it, conducting it or canceling conducting.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionDocument ID. List: GET /v1/catalog-documents
Parameterselect (query) Typestring Requiredno DescriptionComma-separated fields in the response: ?select=id,title,status. Field names are listed in GET /v1/catalog-documents/fields

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-documents/299" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-documents/299', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Document:', data.title, '— conducted:', data.status === 'Y')

JavaScript — OAuth application

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionInventory document (all fields — see Inventory document fields)
Fieldmeta.warnings Typearray DescriptionRequest warnings. Returned when select contains a name that is not among the document fields: code UNKNOWN_SELECT_FIELD, the name in the field field. The other fields are returned

The document's products and warehouses are not included in the response — the item list with filter[docId] returns them.

Response example

JSON 
{
  "success": true,
  "data": {
    "commentary": null,
    "createdBy": 1,
    "currency": "USD",
    "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": "Stock adjustment — documentation check",
    "total": null
  }
}

Error response example

404 — no document with this id:

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

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo document with this id on the portal, including after deletion
HTTP400 CodeINVALID_PARAMS Descriptionid is not a non-negative integer, for example /v1/catalog-documents/abc
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe API key passed was not found
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

See also