Получить список значений пользовательских полей документов складского учета catalog.userfield.document.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров»
Метод catalog.userfield.document.list возвращает постраничный список значений пользовательских полей документов складского учета.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select* |
Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_userfield_document). Обязательно добавьте |
|
filter* |
Объект для фильтрации выбранных записей в формате Возможные значения для Обязательно укажите Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект сортировки в формате Возможные значения для Возможные значения для
Если параметр не передан, применяется сортировка |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["documentType","documentId","field7097"],"filter":{"documentType":"A","documentId":81},"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":81},"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
}>
}
// 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: 81 },
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: 81 },
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>
try {
$response = $b24Service
->core
->call(
'catalog.userfield.document.list',
[
'select' => ['documentType', 'documentId', 'field7097'],
'filter' => ['documentType' => 'A', 'documentId' => 81],
'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: 81 },
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' => 81],
'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": 81,
},
"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": 81,
"documentType": "A",
"field7097": "Тестовое поле"
}
]
},
"total": 1,
"time": {
"start": 1774343822,
"finish": 1774343822.822166,
"duration": 0.8221659660339355,
"processing": 0,
"date_start": "2026-03-24T12:17:02+03:00",
"date_finish": "2026-03-24T12:17:02+03:00",
"operating_reset_at": 1774344422,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
documents |
Список объектов со значениями пользовательских полей документов. Состав полей зависит от параметра |
|
next |
Смещение для следующей страницы. Поле возвращается, если есть еще записи |
|
total |
Общее число записей. Поле не возвращается, если запрос выполнен со |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
HTTP-код: 400
{
"error": "0",
"error_description": "The documentType field is not specified in the filter parameter"
}
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
The documentType field is not specified in the select parameter |
В параметре |
|
|
The documentType field is not specified in the filter parameter |
В параметре |
|
|
Access Denied |
Недостаточно прав для чтения значений пользовательских полей документов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |