Get List of Products in Inventory Documents catalog.document.element.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 product catalog" or "View and select warehouses" permission

The method catalog.document.element.list returns product items of inventory documents with filtering, sorting, and pagination.

The response includes items only of documents whose type the user has the "View" permission for, and only of warehouses available under the "View and select warehouses" permission. Without the "View purchase price" permission, the purchasingPrice field is returned as null.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
array

Array of item fields to return. Available fields: id, docId, elementId, storeFrom, storeTo, amount, purchasingPrice. The fields are described in the catalog_document_element object.

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 select contains no known field, for example ["ID", "AMOUNT"], the method returns all fields

filter
object

Object for filtering items in the format {"field_1": "value_1", ..., "field_N": "value_N"}.

Possible values for field are the fields from the list in select. For example, {"docId": 371} returns the items of document 371.

An additional prefix can be set for the key to specify the filter behavior. Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

An array without a prefix works as IN: {"id": [71, 101]} returns both items. A null value without a prefix finds items with an empty field, for example {"amount": null}.

The < and <= conditions can also find items with an empty field. The substring search prefixes %, =%, and !% do not apply to item fields: all fields are numeric.

The method skips unknown fields and uppercase names, for example AMOUNT, without an error and returns items without applying such a condition. Check field names against the list above

order
object

Object for sorting items in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field are the fields from the list in select.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

The direction is case-insensitive: DESC and desc work the same way. The method skips unknown fields in order without an error

start
integer

This parameter is used for managing pagination.

The page size of results is always static — 50 records.

To select the second page of results, pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the desired page number.

If start is greater than the number of found items, the method returns an empty documentElements array

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","docId","elementId","amount","storeFrom","storeTo"],"filter":{"docId":371},"order":{"id":"ASC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","docId","elementId","amount","storeFrom","storeTo"],"filter":{"docId":371},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.element.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of one position (only the selected fields); empty fields come as null
        type DocumentElement = {
          id: number
          docId: number
          elementId: number | null
          amount: number | null
          storeFrom: number | null
          storeTo: number | null
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DocumentElementListResult = {
          documentElements: DocumentElement[]
        }
        
        try {
          // catalog.document.element.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<DocumentElementListResult>({
            method: 'catalog.document.element.list',
            params: {
              select: [
                'id',
                'docId',
                'elementId',
                'amount',
                'storeFrom',
                'storeTo',
              ],
              filter: {
                docId: 371,
              },
              order: {
                id: 'ASC',
              },
              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(result.documentElements.length, result.documentElements)
          }
        } 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 listDocumentElements() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // catalog.document.element.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({
                method: 'catalog.document.element.list',
                params: {
                  select: [
                    'id',
                    'docId',
                    'elementId',
                    'amount',
                    'storeFrom',
                    'storeTo',
                  ],
                  filter: {
                    docId: 371,
                  },
                  order: {
                    id: 'ASC',
                  },
                  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(result.documentElements.length, result.documentElements)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listDocumentElements)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.document.element.list(
                select=[
                    "id",
                    "docId",
                    "elementId",
                    "amount",
                    "storeFrom",
                    "storeTo",
                ],
                filter={
                    "docId": 371,
                },
                order={
                    "id": "ASC",
                },
                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.element.list',
                    [
                        'select' => [
                            'id',
                            'docId',
                            'elementId',
                            'amount',
                            'storeFrom',
                            'storeTo',
                            'purchasingPrice'
                        ],
                        'filter' => [
                            'docId' => 371
                        ],
                        'order' => [
                            'id' => 'ASC'
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching document elements: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.document.element.list',
            {
                select: [
                    'id',
                    'docId',
                    'elementId',
                    'amount',
                    'storeFrom',
                    'storeTo'
                ],
                filter: {
                    docId: 371
                },
                order: {
                    id: 'ASC'
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.element.list',
            [
                'select' => [
                    'id',
                    'docId',
                    'elementId',
                    'amount',
                    'storeFrom',
                    'storeTo'
                ],
                'filter' => [
                    'docId' => 371
                ],
                'order' => [
                    'id' => 'ASC'
                ],
            ]
        );
        
        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.element.list", b24.Params{
        	"select": []string{"id", "docId", "elementId", "amount", "storeFrom", "storeTo"},
        	"filter": b24.Params{
        		"docId": 371,
        	},
        	"order": b24.Params{
        		"id": "ASC",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.document.element.list: %w", err)
        }
        
        // The method wraps the response in an object with the "documentElements" key.
        raw, ok := b24.Unwrap(res.Result, "documentElements")
        if !ok {
        	return fmt.Errorf("no documentElements key in the response")
        }
        
        // Fields that are not filled in are returned as null, so they use pointers.
        var items []struct {
        	Amount    *float64 `json:"amount"`
        	DocID     b24.ID   `json:"docId"`
        	ElementID *int     `json:"elementId"`
        	ID        b24.ID   `json:"id"`
        	StoreFrom *int     `json:"storeFrom"`
        	StoreTo   *int     `json:"storeTo"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.Amount)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "documentElements": [
                    {
                        "amount": 20,
                        "docId": 371,
                        "elementId": 6595,
                        "id": 71,
                        "storeFrom": null,
                        "storeTo": 43
                    },
                    {
                        "amount": 12,
                        "docId": 371,
                        "elementId": 6595,
                        "id": 101,
                        "storeFrom": null,
                        "storeTo": 43
                    }
                ]
            },
            "total": 2,
            "time": {
                "start": 1793884005,
                "finish": 1793884005.329118,
                "duration": 0.329118013381958,
                "processing": 0,
                "date_start": "2026-11-05T16:06:45+03:00",
                "date_finish": "2026-11-05T16:06:45+03:00",
                "operating_reset_at": 1793884560,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

result.documentElements
catalog_document_element[]

Array of items. Each item contains only the fields from select; fields that are not filled in are returned as null

next
integer

The start value for retrieving the next page. Returned if more than 50 items are found

total
integer

Total number of found items

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "100",
            "error_description": "Invalid order \"BAD\""
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

ERROR_DOCUMENT_RIGHTS

Access denied

The user has neither the "View product catalog" permission nor the "View and select warehouses" permission

400

100

Invalid order "BAD"

order contains a direction other than asc and desc. The message shows the direction in uppercase

400

100

Invalid value {abc} to match with parameter {filter}. Should be value of type array.

filter is not an object. The same error occurs with {select} or {order} if they are neither an array nor an object

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