Get List of Inventory Documents v 3.0 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: catalog

Who can execute the method: a user with the "View and select warehouses" or "View product catalog" permission

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The catalog.document.list method returns a list of inventory documents by filter.

Method Parameters

Name
type

Description

select
array

An array of document fields to return in the response.

Available fields:

  • id — document identifier
  • docType — document type
  • siteId — site identifier
  • responsibleId — identifier of the responsible person
  • dateModify — modification date
  • dateCreate — creation date
  • createdBy — created by
  • modifiedBy — modified by
  • currency — currency
  • status — processing status
  • dateStatus — status change date
  • dateDocument — document date
  • statusBy — status changed by
  • total — total
  • commentary — comment
  • title — title
  • docNumber — incoming document number
  • contractorId — vendor identifier

The id field is always returned, even if it is not in select. The ["*"] value is not supported.

Default: all fields

filter
array

A list filter in REST 3.0 format: an array of conditions like ["field", "operator", "value"], for example [["docType", "=", "A"]]. The filter syntax is described in the REST 3.0 overview.

You can filter by the fields id, docType, siteId, responsibleId, dateModify, dateCreate, createdBy, modifiedBy, currency, status, dateStatus, dateDocument, statusBy, total, title, docNumber, contractorId.

In the filter, pass the processing status status as Y — processed or N — not processed.

The method returns only documents of the types for which the user has the "View" permission

order
object

Sort order in the format {"field": "direction"}, for example {"id": "desc"}.

Possible direction values:

  • asc — ascending
  • desc — descending

You can sort by the fields id, docType, responsibleId, dateModify, dateCreate, createdBy, modifiedBy, status, dateStatus, dateDocument, total, title, docNumber, contractorId

pagination
object

Pagination. Parameter description

Parameter pagination

Name
type

Description

limit
integer

Number of documents per page. The value 0 causes an error.

Default: 50

page
integer

Page number, starting from 1. A page beyond the list returns an empty array

offset
integer

Number of documents to skip from the beginning of the list

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.document.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","docType","title","status","total"],"filter":[["docType","=","A"],["status","=","N"]],"order":{"id":"desc"},"pagination":{"limit":2}}' \
        https://**put_your_bitrix24_address**/rest/api/**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","title","status","total"],"filter":[["docType","=","A"],["status","=","N"]],"order":{"id":"desc"},"pagination":{"limit":2},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.document.list
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentListResult = {
          items: Array<{
            id: number
            docType: string
            status: string
            total: number
            title: string
          }>
        }
        
        try {
          const response = await $b24.actions.v3.call.make<DocumentListResult>({
            method: 'catalog.document.list',
            params: {
              select: ['id', 'docType', 'title', 'status', 'total'],
              filter: [
                ['docType', '=', 'A'],
                ['status', '=', 'N'],
              ],
              order: {
                id: 'desc',
              },
              pagination: {
                limit: 2,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Documents:', result.items.length)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function callDocumentList() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.document.list',
                params: {
                  select: ['id', 'docType', 'title', 'status', 'total'],
                  filter: [
                    ['docType', '=', 'A'],
                    ['status', '=', 'N'],
                  ],
                  order: {
                    id: 'desc',
                  },
                  pagination: {
                    limit: 2,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Documents:', result.items.length)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', callDocumentList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.document.list(
                select=["id", "docType", "title", "status", "total"],
                filter=[
                    ["docType", "=", "A"],
                    ["status", "=", "N"],
                ],
                order={
                    "id": "desc",
                },
                pagination={
                    "limit": 2,
                },
            ).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}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.list',
                    [
                        'select' => ['id', 'docType', 'title', 'status', 'total'],
                        'filter' => [
                            ['docType', '=', 'A'],
                            ['status', '=', 'N'],
                        ],
                        'order' => [
                            'id' => 'desc',
                        ],
                        'pagination' => [
                            'limit' => 2,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.document.list',
            {
                select: ['id', 'docType', 'title', 'status', 'total'],
                filter: [
                    ['docType', '=', 'A'],
                    ['status', '=', 'N'],
                ],
                order: {
                    id: 'desc',
                },
                pagination: {
                    limit: 2,
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.list',
            [
                'select' => ['id', 'docType', 'title', 'status', 'total'],
                'filter' => [
                    ['docType', '=', 'A'],
                    ['status', '=', 'N'],
                ],
                'order' => [
                    'id' => 'desc',
                ],
                'pagination' => [
                    'limit' => 2,
                ],
            ]
        );
        
        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", "title", "status", "total"},
        	"filter":     []any{
        		[]string{"docType", "=", "A"},
        		[]string{"status", "=", "N"},
        	},
        	"order":      b24.Params{
        		"id": "desc",
        	},
        	"pagination": b24.Params{
        		"limit": 2,
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.document.list: %w", err)
        }
        
        var result struct {
        	Items []struct {
        		ID      int     `json:"id"`
        		DocType string  `json:"docType"`
        		Title   string  `json:"title"`
        		Status  string  `json:"status"`
        		Total   float64 `json:"total"`
        	} `json:"items"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, item := range result.Items {
        	fmt.Println(item.ID, item.Title, item.Status)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 343,
                        "docType": "A",
                        "status": "",
                        "total": 15000,
                        "title": "Receipt from vendor Alpha GmbH"
                    },
                    {
                        "id": 319,
                        "docType": "A",
                        "status": "",
                        "total": 8200,
                        "title": "Receipt from vendor Beta GmbH"
                    }
                ]
            },
            "time": {
                "start": 1792665268,
                "finish": 1792665268.074479,
                "duration": 0.0744791030883789,
                "processing": 0,
                "date_start": "2026-10-22T13:34:28+02:00",
                "date_finish": "2026-10-22T13:34:28+02:00",
                "operating_reset_at": 1792665840,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

An object with the response data

result.items
array

An array of documents. The set of fields of each document depends on select. Field description

time
time

Information about the request execution time

Items Element

Name
type

Description

id
integer

Document identifier

docType
string

Document type: A — receipt, S — stock adjustment, M — transfer, R — return, D — write-off

siteId
string

Site identifier, for example s1

responsibleId
integer

Identifier of the responsible person

dateModify
datetime

Date and time of the last change

dateCreate
datetime

Date and time of creation

createdBy
integer

Identifier of the user who created the document

modifiedBy
integer

Identifier of the user who last modified the document

currency
string

Document currency code, for example EUR

status
string

Processing status: "1" — the document is processed, an empty string — not processed

dateStatus
datetime

Date and time of the last status change

dateDocument
datetime or null

Document date. null if the date is not set

statusBy
integer

Identifier of the user who last changed the status. 0 if the status has not changed

total
double

Document total

commentary
string

Comment

title
string

Document title

docNumber
string

Incoming document number

contractorId
integer

Identifier of the vendor from the catalog directory. 0 if no vendor is specified

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "DTO \"DocumentDto\" in field \"commentary\" requires attribute \"Filterable\" to perform this request.",
                        "field": "commentary"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

#FIELD#

DTO DocumentDto in field #FIELD# requires attribute Filterable to perform this request

Remove the non-filterable field from filter

#FIELD#

DTO DocumentDto in field #FIELD# requires attribute Sortable to perform this request

Remove the non-sortable field from order

Filter Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

filter

Invalid filter Unknown filter condition

Pass filter as an array of conditions, for example [["docType","=","A"]]

Filter Operator Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION

Field

Error description

How to Fix

filter

Unknown filter operator #OPERATOR#

Use the operators from the REST 3.0 overview

Pagination Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

pagination

Incorrect pagination parameter value: #PAGINATION#

Pass a positive number in limit

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select, filter, order

Unknown field #FIELD# found in entity DocumentDto

Specify only the fields from the select parameter description

Select Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field

Error description

How to Fix

select

Invalid field in select: #SELECT#

Pass select as an array of strings, for example ["id","title"]

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Make sure the user has the "View and select warehouses" or "View product catalog" permission

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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