Добавить свойство заказа sale.property.add

Scope: sale

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

Метод добавляет свойство заказа.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
fields* `object`	Значения полей для создания свойства заказа

Параметр fields

Общие параметры, актуальные для свойств заказа любого типа:

Обязательные параметры отмечены *

Название `тип`	Описание
personTypeId* `sale_person_type.id`	Идентификатор типа плательщика
propsGroupId* `sale_order_property_group.id`	Идентификатор группы свойств
name* `string`	Название свойства заказа
type* `string`	Тип свойства заказа. Возможные значения: `STRING` `Y/N` `NUMBER` `ENUM` `FILE` `DATE` `LOCATION` `ADDRESS`
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`	Дефолтное значение свойства заказа. Для множественных свойств заказа (multiple) поддерживается передача массива значений
settings `object`	Объект в формате {"field_1": "value_1", ... "field_N": "value_N"} для передачи дополнительных настроек свойства заказа. Список поддерживаемых ключей этого объекта зависит от типа свойства. Для некоторых типов свойств (например, Y/N) дополнительные свойства не предусмотрены. Описание параметра settings для разных типов свойств приведено ниже

Параметры, актуальные для свойств заказа типа STRING

Название `тип`	Описание
isProfileName `string`	Индикатор необходимости использования значения данного свойства заказа в качестве названия профиля пользователя. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
isPayer `string`	Индикатор необходимости использования значения данного свойства заказа в качестве имени плательщика. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
isEmail `string`	Индикатор необходимости использования значения данного свойства заказа в качестве e-mail (например, при регистрации нового пользователя при оформлении заказа). Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
isPhone `string`	Индикатор необходимости использования значения данного свойства заказа в качестве номера телефона. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
isZip `string`	Индикатор необходимости использования значения данного свойства заказа в качестве почтового индекса. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
isAddress `string`	Индикатор необходимости использования значения данного свойства заказа в качестве адреса. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`

Параметры, актуальные для свойств заказа типа LOCATION

Название `тип`	Описание
isLocation `string`	Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для расчета стоимости доставки. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
isLocation4tax `string`	Индикатор необходимости использования значения данного свойства заказа в качестве местоположения покупателя для определения ставок налогов. Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
inputFieldLocation `string`	Устаревшее поле. Не используется

Параметры, актуальные для свойств заказа типа ADDRESS

Название
тип

Описание

isAddressFrom
string

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

Y — да
N — нет

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

isAddressTo
string

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

Y — да
N — нет

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

Параметр settings

Параметры, актуальные для свойств заказа типа STRING

Название `тип`	Описание
minlength `integer`	Минимально допустимая длина (кол-во символов) значения свойства заказа
maxlength `integer`	Максимально допустимая длина (кол-во символов) значения свойства заказа
pattern `string`	Регулярное выражение для проверки значения свойства заказа. Примеры: Регулярное выражение для проверки номера телефона `^((8\\|\+7)[\- ]?)?($?\d{3}$?[\- ]?)?[\d\- ]{7,10}$` Регулярное выражение для проверки написания даты в формате ДД/ММ/ГГГГ: `^(0?[1-9]\|[12][0-9]\|3[01])[\/\-](0?[1-9]\|1[012])[\/\-]\d{4}$`
multiline `string`	Индикатор необходимости отображения многострочного поля для ввода значения свойства.Возможные значения: `Y` — да `N` — нет Если не передано, то по умолчанию выставляется в значение `N`
cols `integer`	Устаревший параметр. Не используется
rows `integer`	Устаревший параметр. Не используется
size `integer`	Устаревший параметр. Не используется

Параметры, актуальные для свойств заказа типа NUMBER

Название `тип`	Описание
min `integer`	Минимально допустимое значение для данного свойства заказа
max `integer`	Максимально допустимое значение для данного свойства заказа
step `integer`	Шаг изменения значения. Используется в некоторых пользовательских интерфейсах для удобства изменения значения свойства заказа

Параметры, актуальные для свойств заказа типа ENUM

Название
тип

Описание

multielement
string

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

Y — да
N — нет

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

size
integer

Количество отображаемых значений свойства заказа. Значение используется в некоторых пользовательских интерфейсах

Параметры, актуальные для свойств заказа типа FILE

Название `тип`	Описание
maxsize `integer`	Максимально допустимый размер загружаемого файла в байтах
accept `string`	Список расширений файлов, которые допустимо загружать в значение данного свойства заказа. Пример: png, doc, zip

Параметры, актуальные для свойств заказа типа DATE

Название
тип

Описание

time
string

Индикатор необходимости добавления возможности выбора времени при работе со значением данного свойства заказа. Значение используется в некоторых пользовательских интерфейсах.
Возможные значения:

Y — да
N — нет

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

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"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.add

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"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.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.property.add', {
        			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.add',
                    [
                        '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 adding property: ' . $e->getMessage();
        }

BX24.callMethod(
        'sale.property.add', {
            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.add',
            [
                '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":1712818563.754118,
              "finish":1712818566.840385,
              "duration":3.0862669944763184,
              "processing":1.0286660194396973,
              "date_start":"2024-04-11T09:56:03+03:00",
              "date_finish":"2024-04-11T09:56:06+03:00"
           }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
property `sale_order_property`	Объект с информацией о добавленном свойстве заказа
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
           "error":0,
           "error_description":"Required fields: propsGroupId"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`200850000005`	Указано пустое значение для типа плательщика
`200850000006`	Внутренняя ошибка добавления свойства
`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`	Не указан или пустой параметр `fields`
`0`	Не переданы обязательные поля
`0`	Другие ошибки (например, фатальные ошибки)

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

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

Добавить свойство заказа sale.property.add

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Параметр settingsПараметр settings

Примеры кодаПримеры кода

Ответ в случае успехаОтвет в случае успеха

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

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

Возможные коды ошибокВозможные коды ошибок

Продолжите изучениеПродолжите изучение

Параметры метода

Параметр fields

Параметр settings

Примеры кода

Ответ в случае успеха

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

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

Возможные коды ошибок

Продолжите изучение