Получить поле товара в документе складского учета catalog.document.element.field.get

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

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

Scope: catalog

Кто может выполнять метод: любой пользователь

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.document.element.field.get возвращает описание поля товарной позиции документа по имени.

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

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

Название
тип

Описание

name*
string

Имя поля, описание которого нужно получить.

Доступные поля:

  • id — идентификатор товарной позиции
  • docId — идентификатор документа
  • storeFrom — склад, с которого списывается товар
  • storeTo — склад, на который поступает товар
  • elementId — идентификатор товара
  • amount — количество
  • purchasingPrice — закупочная цена

select
array

Массив строк с именами свойств описания, которые нужно вернуть в ответе.

Доступные поля:

  • name — имя поля
  • type — тип данных
  • title — заголовок
  • description — описание
  • validationRules — правила валидации
  • requiredGroups — группы обязательности
  • filterable — признак доступности в фильтре
  • sortable — признак доступности в сортировке
  • editable — признак редактируемости
  • editableGroups — группы операций, в которых поле редактируется
  • multiple — признак множественного значения
  • elementType — тип элемента для составных полей

По умолчанию: все свойства описания. Пустой массив [] также возвращает все свойства. Значение ["*"] не поддерживается

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{user_id}/{токен_вебхука}/catalog.document.element.field.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"amount","select":["name","type","requiredGroups","editableGroups"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.field.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"amount","select":["name","type","requiredGroups","editableGroups"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.element.field.get

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentElementFieldGetResult = {
  item: {
    name?: string
    type?: string
    requiredGroups?: string[] | null
    editableGroups?: string[] | null
  }
}

try {
  const response = await $b24.actions.v3.call.make<DocumentElementFieldGetResult>({
    method: 'catalog.document.element.field.get',
    params: {
      name: 'amount',
      select: ['name', 'type', 'requiredGroups', 'editableGroups'],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Field description:', result.item)
  }
} 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 documentElementFieldGet() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.document.element.field.get',
        params: {
          name: 'amount',
          select: ['name', 'type', 'requiredGroups', 'editableGroups'],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Field description:', result.item)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', documentElementFieldGet)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.element.field.get(
        name="amount",
        select=["name", "type", "requiredGroups", "editableGroups"],
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.document.element.field.get',
            [
                'name' => 'amount',
                'select' => ['name', 'type', 'requiredGroups', 'editableGroups'],
            ]
        );

    $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();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.document.element.field.get',
    {
        name: 'amount',
        select: ['name', 'type', 'requiredGroups', 'editableGroups'],
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.document.element.field.get',
    [
        'name' => 'amount',
        'select' => ['name', 'type', 'requiredGroups', 'editableGroups'],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.element.field.get", b24.Params{
	"name":   "amount",
	"select": []string{"name", "type", "requiredGroups", "editableGroups"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.document.element.field.get: %w", err)
}

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

var item struct {
	Name           string   `json:"name"`
	Type           string   `json:"type"`
	EditableGroups []string `json:"editableGroups"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Name, item.Type)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "name": "amount",
            "type": "float",
            "requiredGroups": null,
            "editableGroups": [
                "add",
                "update"
            ]
        }
    },
    "time": {
        "start": 1792665374,
        "finish": 1792665374.566398,
        "duration": 0.5663979053497314,
        "processing": 0,
        "date_start": "2026-10-22T13:36:14+03:00",
        "date_finish": "2026-10-22T13:36:14+03:00",
        "operating_reset_at": 1792665960,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Описание поля. Свойства объекта зависят от select

time
time

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

Объект item

Состав описания зависит от select. Таблица содержит все свойства, которые можно запросить.

Название
тип

Описание

name
string

Имя поля: id, docId, storeFrom, storeTo, elementId, amount, purchasingPrice

type
string

Тип в метаданных: int для идентификаторов и складов, float для amount и purchasingPrice

title
string

Заголовок поля. Совпадает с name

description
string или null

Описание поля. Для полей этого объекта — null

validationRules
array

Массив правил валидации. Для полей этого объекта — пустой массив []

requiredGroups
array или null

Массив строк с именами операций, в которых поле обязательно. Для docId и elementId — ["add"], для остальных полей — null

filterable
boolean

true — поле доступно для фильтрации, false — недоступно

sortable
boolean

true — поле доступно для сортировки, false — недоступно

editable
boolean

true — поле можно передавать в операциях из editableGroups, false — нельзя

editableGroups
array или null

Массив строк с именами операций, в которых поле можно задавать. Для docId и elementId — ["add"], для storeFrom, storeTo, amount, purchasingPrice — ["add", "update"], для id — null

multiple
boolean

Признак множественного значения. Для всех полей — false

elementType
string или null

Тип элемента составного поля. Для всех полей — null

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

HTTP-статус: 404

{
    "error": {
        "code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
        "message": "Поле `foo` не найдено"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибка отсутствия поля

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

HTTP-статус: 404

Поле

Описание ошибки

Как исправить

name

Поле #FIELD# не найдено

Укажите имя поля из описания параметра name

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

name

Обязательное поле name не указано

Передайте параметр name

Ошибки в параметре select

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для сущности DtoFieldDto

Передайте только поля из описания параметра select

Ошибка формата select

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле

Описание ошибки

Как исправить

select

Не удается распознать выражение select #SELECT#

Передайте select как массив строк, например ["name","type"]

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

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

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

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

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

Предыдущая
Получить список полей товаров для документа складского учета v 3.0
Следующая
Обзор методов