Изменить значения пользовательских полей документов складского учета catalog.userfield.document.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правами «Просмотр» и «Создание и редактирование» для документов этого типа, а также «Просмотр каталога товаров» и «Просмотр раздела Складской учет»
Метод catalog.userfield.document.update обновляет значения пользовательских полей документа складского учета.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
documentId* |
Идентификатор документа складского учета. Идентификатор можно получить методом catalog.document.list |
|
fields* |
Поля для обновления (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
documentType* |
Тип документа складского учета. Должен совпадать с типом документа Допустимые значения: типы документов складского учета |
|
fieldN |
Значение пользовательского поля, где Идентификаторы и настройки пользовательских полей можно получить методом userfieldconfig.list. Ключи Чтобы очистить значение, передайте пустую строку или |
Метод меняет только переданные пользовательские поля. Ключи в другом формате, например коды UF_*, и поля, которых нет у документов этого типа, метод пропускает без ошибки. Значения можно изменить и у проведенного документа.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":351,"fields":{"documentType":"A","field7097":"Поставка по договору № 15"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.userfield.document.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":351,"fields":{"documentType":"A","field7097":"Поставка по договору № 15"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.userfield.document.update
// 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 UpdateUserfieldDocumentResult = {
document: {
documentId: number
documentType: string
[field: string]: unknown
}
}
try {
const response = await $b24.actions.v2.call.make<UpdateUserfieldDocumentResult>({
method: 'catalog.userfield.document.update',
params: {
documentId: 351,
fields: {
documentType: 'A',
field7097: 'Поставка по договору № 15',
},
},
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.document)
}
} 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 updateUserfieldDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.userfield.document.update',
params: {
documentId: 351,
fields: {
documentType: 'A',
field7097: 'Поставка по договору № 15',
},
},
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.document)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateUserfieldDocument)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.userfield.document.update(
document_id=351,
fields={
"documentType": "A",
"field7097": "Поставка по договору № 15",
},
).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.update',
[
'documentId' => 351,
'fields' => [
'documentType' => 'A',
'field7097' => 'Поставка по договору № 15',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result['document']);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating document user fields: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.userfield.document.update',
{
documentId: 351,
fields: {
documentType: 'A',
field7097: 'Поставка по договору № 15'
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.userfield.document.update',
[
'documentId' => 351,
'fields' => [
'documentType' => 'A',
'field7097' => 'Поставка по договору № 15',
],
]
);
echo '<PRE>';
print_r($result['result']['document']);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.userfield.document.update", b24.Params{
"documentId": 351,
"fields": b24.Params{
"documentType": "A",
"field7097": "Поставка по договору № 15",
},
})
if err != nil {
return fmt.Errorf("catalog.userfield.document.update: %w", err)
}
// Метод заворачивает ответ в объект с ключом "document".
raw, ok := b24.Unwrap(res.Result, "document")
if !ok {
return fmt.Errorf("в ответе нет ключа document")
}
var item struct {
DocumentID b24.ID `json:"documentId"`
DocumentType string `json:"documentType"`
Field7097 *string `json:"field7097"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.DocumentID, item.DocumentType)
Обработка ответа
HTTP-статус: 200
{
"result": {
"document": {
"documentId": 351,
"documentType": "A",
"field7097": "Поставка по договору № 15"
}
},
"time": {
"start": 1793875710,
"finish": 1793875710.096168,
"duration": 0.09616804122924805,
"processing": 0,
"date_start": "2026-11-05T13:48:30+03:00",
"date_finish": "2026-11-05T13:48:30+03:00",
"operating_reset_at": 1793876280,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
result.document |
Объект с обновленными значениями пользовательских полей документа |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "The specified document does not exist"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access Denied |
У пользователя нет права «Создание и редактирование» или «Просмотр» для документов этого типа, либо права «Просмотр каталога товаров» или «Просмотр раздела Складской учет» |
|
|
|
The specified document does not exist |
Документ с указанным |
|
|
|
Could not find value for parameter |
Не передан параметр |
|
|
|
Could not find value for parameter |
Не передан параметр |
|
|
|
Required fields: documentType |
В |
|
|
|
The DOC_TYPE field does not match the document |
Значение |
|
|
|
Internal server error. |
В пользовательское поле с одним значением передан массив |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |