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
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.element.getFields
// 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
type FieldDescription = {
isImmutable: boolean
isReadOnly: boolean
isRequired: boolean
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentElementFieldsResult = {
documentElement: Record<string, FieldDescription>
}
try {
const response = await $b24.actions.v2.call.make<DocumentElementFieldsResult>({
method: 'catalog.document.element.getFields',
params: {},
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(
Object.keys(result.documentElement),
result.documentElement
)
}
} 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 getDocumentElementFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.element.getFields',
params: {},
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(
Object.keys(result.documentElement),
result.documentElement
)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDocumentElementFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.element.get_fields().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.document.element.getFields',
[]
);
$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 getting document element fields: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.element.getFields',
{},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.element.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.element.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.document.element.getFields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "documentElement".
raw, ok := b24.Unwrap(res.Result, "documentElement")
if !ok {
return fmt.Errorf("в ответе нет ключа documentElement")
}
fmt.Printf("%s\n", raw)
Ответ
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 |
Прочие ошибки обработки |

