Получить список значений пользовательских полей документов складского учета catalog.userfield.document.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр» для документов этого типа, а также «Просмотр каталога товаров» и «Просмотр раздела Складской учет»

Метод catalog.userfield.document.list возвращает значения пользовательских полей документов складского учета одного типа с фильтрацией, сортировкой и постраничной навигацией.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

select*
array

Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_userfield_document): documentId, documentType и пользовательские поля в формате fieldN, где N — идентификатор поля, например field7097.

Обязательно добавьте documentType — тип документа складского учета. Неизвестные поля метод пропускает без ошибки

filter*
object

Объект для фильтрации выбранных записей в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта catalog_userfield_document.

Обязательно укажите documentType — тип документа складского учета.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении
  • %= — LIKE (аналогично =%)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении
  • !%= — NOT LIKE (аналогично !=%)
  • = — равно, точное совпадение, используется по умолчанию
  • != — не равно
  • ! — не равно

Массив без префикса работает как IN: {"documentId": [3, 351]} вернет оба документа. Условия NOT LIKE !%, !=%, !%= не находят документы, у которых поле не заполнено.

Если тип документа не существует, например {"documentType": "Z"}, метод вернет "result": null без ошибки. Неизвестные поля в фильтре метод пропускает без ошибки

order
object

Объект сортировки в формате {"field_1": "order_1", ..., "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта catalog_userfield_document.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

Если параметр не передан, метод не задает сортировку явно. Для стабильного порядка при постраничной выборке передайте сортировку, например {"documentId": "asc"}. Регистр направления не важен

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы.

Если start больше количества найденных записей, метод вернет пустой массив documents

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["documentType","documentId","field7097"],"filter":{"documentType":"A","documentId":351},"order":{"documentId":"ASC"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.userfield.document.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["documentType","documentId","field7097"],"filter":{"documentType":"A","documentId":351},"order":{"documentId":"ASC"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.userfield.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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type UserfieldDocumentListResult = {
  documents: Array<{
    documentId: number
    documentType: string
    field7097: string | null
  }>
}

// catalog.userfield.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.
try {
  const response = await $b24.actions.v2.call.make<UserfieldDocumentListResult>({
    method: 'catalog.userfield.document.list',
    params: {
      select: ['documentType', 'documentId', 'field7097'],
      filter: { documentType: 'A', documentId: 351 },
      order: { documentId: '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.documents, `page size: ${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 listUserfieldDocuments() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // catalog.userfield.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({
        method: 'catalog.userfield.document.list',
        params: {
          select: ['documentType', 'documentId', 'field7097'],
          filter: { documentType: 'A', documentId: 351 },
          order: { documentId: '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.documents, `page size: ${result.documents.length}`)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listUserfieldDocuments)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.userfield.document.list(
        select=[
            "documentType",
            "documentId",
            "field7097",
        ],
        filter={
            "documentType": "A",
            "documentId": 351,
        },
        order={
            "documentId": "ASC",
        },
        start=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.userfield.document.list',
            [
                'select' => ['documentType', 'documentId', 'field7097'],
                'filter' => ['documentType' => 'A', 'documentId' => 351],
                'order' => ['documentId' => 'ASC'],
                'start' => 0
            ]
        );

    print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
    echo $exception->getMessage();
}
BX24.callMethod(
    'catalog.userfield.document.list',
    {
        select: ['documentType', 'documentId', 'field7097'],
        filter: { documentType: 'A', documentId: 351 },
        order:  { documentId: 'ASC' }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());

            if (result.more()) {
                result.next();
            }
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'catalog.userfield.document.list',
    [
        'select' => ['documentType', 'documentId', 'field7097'],
        'filter' => ['documentType' => 'A', 'documentId' => 351],
        'order' => ['documentId' => 'ASC'],
        'start' => 0
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.userfield.document.list", b24.Params{
	"select": []string{"documentType", "documentId", "field7097"},
	"filter": b24.Params{
		"documentType": "A",
		"documentId":   351,
	},
	"order": b24.Params{
		"documentId": "ASC",
	},
	"start": 0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.userfield.document.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "documents".
raw, ok := b24.Unwrap(res.Result, "documents")
if !ok {
	return fmt.Errorf("в ответе нет ключа documents")
}

var items []struct {
	DocumentID   b24.ID  `json:"documentId"`
	DocumentType string  `json:"documentType"`
	Field7097    *string `json:"field7097"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.DocumentID)
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "documents": [
            {
                "documentId": 351,
                "documentType": "A",
                "field7097": "Поставка по договору № 15"
            }
        ]
    },
    "total": 1,
    "time": {
        "start": 1793875713,
        "finish": 1793875713.347841,
        "duration": 0.3478410243988037,
        "processing": 0,
        "date_start": "2026-11-05T13:48:33+03:00",
        "date_finish": "2026-11-05T13:48:33+03:00",
        "operating_reset_at": 1793875920,
        "operating": 0.12599587440490723
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа

result.documents
catalog_userfield_document[]

Список объектов со значениями пользовательских полей документов. Состав полей зависит от параметра select

next
integer

Смещение для следующей страницы. Поле возвращается, если есть еще записи

total
integer

Общее число записей. Поле не возвращается, если запрос выполнен со start = -1

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "The documentType field is not specified in the filter parameter"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

0

The documentType field is not specified in the select parameter

В параметре select не указан documentType

400

0

The documentType field is not specified in the filter parameter

В параметре filter не указан documentType

400

0

Access Denied

У пользователя нет права «Просмотр» для документов этого типа, либо права «Просмотр каталога товаров» или «Просмотр раздела Складской учет»

400

100

Invalid order "BAD"

В order передано направление, отличное от asc и desc. В тексте направление приведено к верхнему регистру

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

403

FEATURE_NOT_AVAILABLE_ON_CURRENT_PLAN
Функция недоступна на текущем тарифе.

Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение