Обновить свойство заказа sale.property.update
Scope:
saleКто может выполнять метод: администратор
Метод обновляет свойство заказа.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор свойства заказа |
|
|
fields* |
Значения полей для создания свойства заказа |
Параметр fields
Общие параметры, актуальные для свойств заказа любого типа:
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Название свойства заказа |
|
code |
Символьный код свойства заказа |
|
active |
Индикатор активности свойства заказа.
Если не передано, то по умолчанию значение |
|
util |
Индикатор, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части.
Если не передано, то по умолчанию значение |
|
userProps |
Индикатор, входит ли свойство заказа в профиль покупателя.
Если не передано, то по умолчанию значение |
|
isFiltered |
Индикатор, доступно ли свойство заказа в фильтре на странице списка заказов.
Если не передано, то по умолчанию значение |
|
sort |
Сортировка |
|
description |
Описание свойства заказа |
|
required |
Индикатор обязательности заполнения значения свойства заказа.
Если не передано, то по умолчанию значение |
|
multiple |
Индикатор, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений.
Если не передано, то по умолчанию значение |
|
xmlId |
Внешний идентификатор свойства заказа |
|
defaultValue |
Дефолтное значение свойства заказа. |
|
settings |
Объект в формате {"field_1": "value_1", ... "field_N": "value_N"} для передачи дополнительных настроек свойства заказа. Список поддерживаемых ключей этого объекта зависит от типа свойства. Для некоторых типов свойств (например, Y/N) дополнительные свойства не предусмотрены. Описание параметра settings для разных типов свойств приведено в описании метода |
Параметры, актуальные для свойств заказа типа STRING
|
Название |
Описание |
|
isProfileName |
Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя.
Если не передано, то по умолчанию выставляется в значение |
|
isPayer |
Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика.
Если не передано, то по умолчанию выставляется в значение |
|
isEmail |
Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа).
Если не передано, то по умолчанию выставляется в значение |
|
isPhone |
Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона.
Если не передано, то по умолчанию выставляется в значение |
|
isZip |
Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса.
Если не передано, то по умолчанию выставляется в значение |
|
isAddress |
Индикатор необходимости использования значения данного свойства заказа в качестве адреса.
Если не передано, то по умолчанию выставляется в значение |
Параметры, актуальные для свойств заказа типа LOCATION
|
Название |
Описание |
|
isLocation |
Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки.
Если не передано, то по умолчанию выставляется в значение |
|
isLocation4tax |
Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов.
Если не передано, то по умолчанию выставляется в значение |
|
inputFieldLocation |
Устаревшее поле. Не используется. |
Параметры, актуальные для свойств заказа типа ADDRESS
|
Название |
Описание |
|
isAddressFrom |
Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, откуда необходимо забрать заказ для расчета стоимости доставки.
Если не передано, то по умолчанию выставляется в значение |
|
isAddressTo |
Индикатор необходимости использования значения данного свойства заказа в качестве адреса покупателя, куда необходимо доставить заказ для расчета стоимости доставки.
Если не передано, то по умолчанию выставляется в значение |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":93,"fields":{"personTypeId":3,"propsGroupId":6,"name":"Телефон (для связи с курьером)","type":"STRING","code":"PHONE","active":"Y","util":"N","userProps":"Y","isFiltered":"N","sort":500,"description":"описание свойства","required":"Y","multiple":"N","settings":{"multiline":"Y","maxlength":100},"xmlId":"","defaultValue":"","isProfileName":"Y","isPayer":"Y","isEmail":"N","isPhone":"N","isZip":"N","isAddress":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.property.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":93,"fields":{"personTypeId":3,"propsGroupId":6,"name":"Телефон (для связи с курьером)","type":"STRING","code":"PHONE","active":"Y","util":"N","userProps":"Y","isFiltered":"N","sort":500,"description":"описание свойства","required":"Y","multiple":"N","settings":{"multiline":"Y","maxlength":100},"xmlId":"","defaultValue":"","isProfileName":"Y","isPayer":"Y","isEmail":"N","isPhone":"N","isZip":"N","isAddress":"N"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.property.update
try
{
const response = await $b24.callMethod(
'sale.property.update', {
id: 93,
fields: {
personTypeId: 3,
propsGroupId: 6,
name: 'Телефон (для связи с курьером)',
type: 'STRING',
code: 'PHONE',
active: 'Y',
util: 'N',
userProps: 'Y',
isFiltered: 'N',
sort: 500,
description: 'описание свойства',
required: 'Y',
multiple: 'N',
settings: {
multiline: 'Y',
maxlength: 100
},
xmlId: '',
defaultValue: '',
isProfileName: 'Y',
isPayer: 'Y',
isEmail: 'N',
isPhone: 'N',
isZip: 'N',
isAddress: 'N',
}
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.property.update',
[
'id' => 93,
'fields' => [
'personTypeId' => 3,
'propsGroupId' => 6,
'name' => 'Телефон (для связи с курьером)',
'type' => 'STRING',
'code' => 'PHONE',
'active' => 'Y',
'util' => 'N',
'userProps' => 'Y',
'isFiltered' => 'N',
'sort' => 500,
'description' => 'описание свойства',
'required' => 'Y',
'multiple' => 'N',
'settings' => [
'multiline' => 'Y',
'maxlength' => 100,
],
'xmlId' => '',
'defaultValue' => '',
'isProfileName' => 'Y',
'isPayer' => 'Y',
'isEmail' => 'N',
'isPhone' => 'N',
'isZip' => 'N',
'isAddress' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating sale property: ' . $e->getMessage();
}
BX24.callMethod(
'sale.property.update', {
id: 93,
fields: {
personTypeId: 3,
propsGroupId: 6,
name: 'Телефон (для связи с курьером)',
type: 'STRING',
code: 'PHONE',
active: 'Y',
util: 'N',
userProps: 'Y',
isFiltered: 'N',
sort: 500,
description: 'описание свойства',
required: 'Y',
multiple: 'N',
settings: {
multiline: 'Y',
maxlength: 100
},
xmlId: '',
defaultValue: '',
isProfileName: 'Y',
isPayer: 'Y',
isEmail: 'N',
isPhone: 'N',
isZip: 'N',
isAddress: 'N',
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.property.update',
[
'id' => 93,
'fields' => [
'personTypeId' => 3,
'propsGroupId' => 6,
'name' => 'Телефон (для связи с курьером)',
'type' => 'STRING',
'code' => 'PHONE',
'active' => 'Y',
'util' => 'N',
'userProps' => 'Y',
'isFiltered' => 'N',
'sort' => 500,
'description' => 'описание свойства',
'required' => 'Y',
'multiple' => 'N',
'settings' => [
'multiline' => 'Y',
'maxlength' => 100
],
'xmlId' => '',
'defaultValue' => '',
'isProfileName' => 'Y',
'isPayer' => 'Y',
'isEmail' => 'N',
'isPhone' => 'N',
'isZip' => 'N',
'isAddress' => 'N',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Ответ в случае успеха
HTTP-статус: 200
{
"result":{
"property":{
"active":"Y",
"code":"PHONE",
"defaultValue":"",
"description":"описание свойства",
"id":96,
"inputFieldLocation":"0",
"isAddress":"N",
"isAddressFrom":"N",
"isAddressTo":"N",
"isEmail":"N",
"isFiltered":"N",
"isLocation":"N",
"isLocation4tax":"N",
"isPayer":"Y",
"isPhone":"N",
"isProfileName":"Y",
"isZip":"N",
"multiple":"N",
"name":"Телефон (для связи с курьером)",
"personTypeId":3,
"propsGroupId":6,
"required":"Y",
"settings":{
"maxlength":"100",
"multiline":"Y"
},
"sort":500,
"type":"STRING",
"userProps":"Y",
"util":"N",
"xmlId":""
}
},
"time":{
"start":1712818736.235335,
"finish":1712818736.611224,
"duration":0.3758888244628906,
"processing":0.18679594993591309,
"date_start":"2024-04-11T09:58:56+03:00",
"date_finish":"2024-04-11T09:58:56+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
property |
Объект с информацией об обновленном свойстве заказа |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200840400001,
"error_description":"property is not exists"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Обновляемое свойство заказа не найдено |
|
|
Внутренняя ошибка обновления свойства |
|
|
Ошибка возникает при попытке обновить свойство заказа со значением параметра |
|
|
Ошибка возникает при попытке обновить свойство заказа со значением параметра |
|
|
Ошибка возникает при попытке обновить свойство заказа с типом |
|
|
Ошибка возникает при попытке обновить свойство заказа с типом |
|
|
Ошибка возникает при попытке обновить свойство заказа с типом |
|
|
Ошибка возникает при попытке обновить свойство заказа с типом |
|
|
Ошибка возникает при попытке обновить свойство заказа с типом |
|
|
Ошибка возникает при попытке обновить свойство заказа с типом |
|
|
Недостаточно прав для обновления свойства заказа |
|
|
Не указан параметр |
|
|
Не указан или пустой параметр |
|
|
Не переданы обязательные поля |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Свойства заказа в Интернет-магазине: обзор методов
- Добавить свойство заказа sale.property.add
- Получить свойство заказа sale.property.get
- Получить список свойств заказа sale.property.list
- Удалить свойство заказа sale.property.delete
- Получить поля и настройки свойства заказа для определенного типа свойств sale.property.getfieldsbytype