метод REST scope: sale

sale.property.update

Обновить свойство заказа

Кто может выполнять: администратор

Описание

Метод sale.property.update обновляет свойство заказа.

Параметры

id sale_order_property.id обязательный

Идентификатор свойства заказа

fields object обязательный

Значения полей для создания свойства заказа

Параметр fields

name string обязательный

Название свойства заказа

code string необязательный

Символьный код свойства заказа

active string необязательный

Индикатор активности свойства заказа.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение Y

util string необязательный

Индикатор, является ли свойство заказа служебным. Служебные свойства заказа не отображаются в публичной части.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

userProps string необязательный

Индикатор, входит ли свойство заказа в профиль покупателя.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

isFiltered string необязательный

Индикатор, доступно ли свойство заказа в фильтре на странице списка заказов.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

sort integer необязательный

Сортировка

description string необязательный

Описание свойства заказа

required string необязательный

Индикатор обязательности заполнения значения свойства заказа.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

multiple string необязательный

Индикатор, является ли свойство заказа множественным. Для множественных свойств возможно указать несколько значений.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

xmlId string необязательный

Внешний идентификатор свойства заказа

defaultValue any необязательный

Дефолтное значение свойства заказа.

Для свойств типа file нужно передать объект в формате {"fileData": ["value1", "value2"]}:
- value1 — название файла с расширением,
- value2 — файл в формате base64.

Для удаления файла используется объект в формате {"remove": "Y"}.

Для множественных свойств заказа (multiple) поддерживается передача массива значений
Для удаления значения нужно передать null, либо не передавать параметр

settings object необязательный

Объект в формате {"field_1": "value_1", ... "field_N": "value_N"} для передачи дополнительных настроек свойства заказа.

Список поддерживаемых ключей этого объекта зависит от типа свойства. Для некоторых типов свойств (например, Y/N) дополнительные свойства не предусмотрены. Описание параметра settings для разных типов свойств приведено в описании метода sale.property.add

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

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

Ответ

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 object

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

property sale_order_property

Объект с информацией об обновленном свойстве заказа

time time

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

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

HTTP-статус: 400

{
   "error":200840400001,
   "error_description":"property is not exists"
}
Код Описание Значение
200840400001 Обновляемое свойство заказа не найдено
200850000003 Внутренняя ошибка обновления свойства
200850000009 Ошибка возникает при попытке обновить свойство заказа со значением параметра multiple, выставленным в Y, в том случае, если не передан параметр isFiltered.
Фильтрация по множественным свойствам заказов не поддерживается
200850000010 Ошибка возникает при попытке обновить свойство заказа со значением параметра multiple, выставленным в Y, в том случае, если значение параметра isFiltered не равно N.
Фильтрация по множественным свойствам заказов не поддерживается
200850000011 Ошибка возникает при попытке обновить свойство заказа с типом LOCATION и значением параметра isLocation, выставленным в Y, в том случае, если значение параметра multiple не указано.
Не поддерживается множественность у свойств заказа отмеченных индикатором isLocation
200850000012 Ошибка возникает при попытке обновить свойство заказа с типом LOCATION и значением параметра isLocation, выставленным в Y, в том случае, если значение параметра multiple не равноN.
Не поддерживается множественность у свойств заказа отмеченных индикатором isLocation
200850000013 Ошибка возникает при попытке обновить свойство заказа с типом LOCATION и значением параметра isLocation4tax, выставленным в Y, в том случае, если значение параметра multiple не указано.
Не поддерживается множественность у свойств заказа отмеченных индикатором isLocation4tax
200850000014 Ошибка возникает при попытке обновить свойство заказа с типом LOCATION и значением параметра isLocation4tax, выставленным в Y, в том случае, если значение параметра multiple не равно N.
Не поддерживается множественность у свойств заказа отмеченных индикатором isLocation4tax
200850000015 Ошибка возникает при попытке обновить свойство заказа с типом STRING и значением параметра isProfileName, выставленным в Y, в том случае, если значение параметра required не указано.
Название профиля обязательно и не может быть пустым
200850000016 Ошибка возникает при попытке обновить свойство заказа с типом STRING и значением параметра isProfileName, выставленным в Y, в том случае, если значение параметра required не равно Y.
Название профиля обязательно и не может быть пустым
200040300020 Недостаточно прав для обновления свойства заказа
100 Не указан параметр id
100 Не указан или пустой параметр fields
0 Не переданы обязательные поля
0 Другие ошибки (например, фатальные ошибки)

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

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