метод REST scope: catalog

catalog.document.element.getFields

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

Кто может выполнять: пользователи с правом «Просмотр каталога товаров»

Описание

Метод catalog.document.element.getFields возвращает описание полей товара из документа складского учета.

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.getFields

Ответ

HTTP-статус: 200

{
    "result": {
        "documentElement": {
            "amount": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "double"
            },
            "docId": {
                "isImmutable": true,
                "isReadOnly": false,
                "isRequired": true,
                "type": "integer"
            },
            "elementId": {
                "isImmutable": true,
                "isReadOnly": false,
                "isRequired": true,
                "type": "integer"
            },
            "id": {
                "isImmutable": false,
                "isReadOnly": true,
                "isRequired": false,
                "type": "integer"
            },
            "purchasingPrice": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "double"
            },
            "storeFrom": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "integer"
            },
            "storeTo": {
                "isImmutable": false,
                "isReadOnly": false,
                "isRequired": false,
                "type": "integer"
            }
        }
    },
    "time": {
        "start": 1759482101.114239,
        "finish": 1759482101.178452,
        "duration": 0.06421303749084473,
        "processing": 0.008214950561523438,
        "date_start": "2025-11-02T12:21:41+03:00",
        "date_finish": "2025-11-02T12:21:41+03:00",
        "operating": 0
    }
}

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

result object

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

documentElement object

Объект с описанием полей товара документа.
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}. Где field — идентификатор поля объекта catalog_document_element, а value — объект типа rest_field_description.

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

HTTP-статус: 400

{
    "error": "ERROR_DOCUMENT_RIGHTS",
    "error_description": "Access denied"
}
Код Описание Значение
ERROR_DOCUMENT_RIGHTS Access denied Недостаточно прав для чтения документов складского учета
0 Прочие ошибки обработки

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.