Get List of Inventory Documents catalog.document.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with the "View product catalog" or "View and select warehouses" permission
The method catalog.document.list returns a list of inventory documents with filtering, sorting, and pagination.
The response includes only documents of the types for which the user has the "View" permission, and only with warehouses available to the user. The method does not return reservation cancellation documents, type U.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
Array of document fields to return. Available fields: If the array is not passed or is empty, the method returns all fields. The method skips unknown fields without an error. Write field names in camelCase: if |
|
filter |
Object for filtering documents in the format Possible values for An additional prefix can be set for the key to specify the filter behavior. Possible prefix values:
An array without a prefix works as IN: The method skips unknown fields and uppercase names, for example |
|
order |
Object for sorting documents in the format Possible values for Possible values for
The direction is case-insensitive: |
|
start |
This parameter is used to manage pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value The formula for calculating the
If there is a next page, the response contains the |
Code Examples
How to Use Examples in Documentation
The example retrieves draft stock adjustment documents whose name contains "Surplus stock adjustment", starting with the newest.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","docType","docNumber","title","status","dateDocument","total"],"filter":{"docType":"S","status":"N","%title":"Surplus stock adjustment"},"order":{"id":"desc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","docType","docNumber","title","status","dateDocument","total"],"filter":{"docType":"S","status":"N","%title":"Surplus stock adjustment"},"order":{"id":"desc"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of one document returned in result.documents (only the selected fields)
type DocumentListItem = {
id: number
docType: string
docNumber: string | null
title: string | null
status: string
dateDocument: ISODate | null
total: number | null
}
try {
// catalog.document.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<{ documents: DocumentListItem[] }>({
method: 'catalog.document.list',
params: {
select: ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
filter: {
docType: 'S',
status: 'N',
'%title': 'Surplus stock adjustment',
},
order: {
id: 'desc',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Documents on page:', result.documents.length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listDocuments() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.list',
params: {
select: ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
filter: {
docType: 'S',
status: 'N',
'%title': 'Surplus stock adjustment',
},
order: {
id: 'desc',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Documents on page:', result.documents.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDocuments)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.list(
select=["id", "docType", "docNumber", "title", "status", "dateDocument", "total"],
filter={
"docType": "S",
"status": "N",
"%title": "Surplus stock adjustment",
},
order={
"id": "desc",
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.document.list',
[
'select' => ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
'filter' => [
'docType' => 'S',
'status' => 'N',
'%title' => 'Surplus stock adjustment',
],
'order' => [
'id' => 'desc',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.document.list',
{
select: ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
filter: {
docType: 'S',
status: 'N',
'%title': 'Surplus stock adjustment',
},
order: {
id: 'desc',
},
start: 0,
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.list',
[
'select' => ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
'filter' => [
'docType' => 'S',
'status' => 'N',
'%title' => 'Surplus stock adjustment',
],
'order' => [
'id' => 'desc',
],
'start' => 0,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.document.list", b24.Params{
"select": []string{"id", "docType", "docNumber", "title", "status", "dateDocument", "total"},
"filter": b24.Params{
"docType": "S",
"status": "N",
"%title": "Surplus stock adjustment",
},
"order": b24.Params{
"id": "desc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.document.list: %w", err)
}
// The method wraps the response in an object with the "documents" key.
raw, ok := b24.Unwrap(res.Result, "documents")
if !ok {
return fmt.Errorf("no documents key in the response")
}
// Optional fields can be null, so pointers are used for them.
var items []struct {
ID b24.ID `json:"id"`
DocType string `json:"docType"`
DocNumber *string `json:"docNumber"`
Title *string `json:"title"`
Status string `json:"status"`
DateDocument *string `json:"dateDocument"`
Total *float64 `json:"total"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Status)
}
Response Handling
HTTP status: 200
{
"result": {
"documents": [
{
"dateDocument": "2026-11-06T10:00:00+03:00",
"docNumber": "OP-00042",
"docType": "S",
"id": 381,
"status": "N",
"title": "Surplus stock adjustment",
"total": null
}
]
},
"total": 1,
"time": {
"start": 1793883564,
"finish": 1793883564.287555,
"duration": 0.2875549793243408,
"processing": 0,
"date_start": "2026-11-05T15:59:24+03:00",
"date_finish": "2026-11-05T15:59:24+03:00",
"operating_reset_at": 1793884140,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response |
|
result.documents |
Array of documents. Each document has only the fields from |
|
next |
The |
|
total |
Total number of documents found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "100",
"error_description": "Invalid order \"BAD\""
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Insufficient permissions to save the inventory object. |
The user has neither the "View product catalog" permission nor the "View and select warehouses" permission |
|
|
|
Invalid order "BAD" |
|
|
|
|
Invalid value {abc} to match with parameter {filter}. Should be value of type array. |
|
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create Inventory Document catalog.document.add
- Update Inventory Document catalog.document.update
- Delete Inventory Document catalog.document.delete
- Process Inventory Document catalog.document.conduct
- Get Description of Fields for Inventory Document catalog.document.getFields
- Get List of Products in Inventory Documents catalog.document.element.list