Добавить вариант свойства sale.propertyvariant.add

Scope: sale

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

Метод добавляет вариант значения свойства. Метод актуален только для свойств с типом ENUM.

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

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

Название
тип

Описание

fields*
object

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

Параметр fields

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

Название
тип

Описание

orderPropsId*
sale_order_property.id

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

name*
string

Название варианта значения свойства

value*
string

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

sort
integer

Сортировка

description
string

Описание варианта значения свойства

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Красный","orderPropsId":49,"value":"red","sort":10,"description":"Описание значения для красного цвета"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertyvariant.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Красный","orderPropsId":49,"value":"red","sort":10,"description":"Описание значения для красного цвета"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.propertyvariant.add
        
try
        {
        	const response = await $b24.callMethod(
        		"sale.propertyvariant.add", {
        			"fields": {
        				"name": "Красный",
        				"orderPropsId": 49,
        				"value": "red",
        				"sort": 10,
        				"description": "Описание значения для красного цвета"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.propertyvariant.add',
                    [
                        'fields' => [
                            'name'         => 'Красный',
                            'orderPropsId' => 49,
                            'value'        => 'red',
                            'sort'         => 10,
                            'description'  => 'Описание значения для красного цвета',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding property variant: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.propertyvariant.add", {
                "fields": {
                    "name": "Красный",
                    "orderPropsId": 49,
                    "value": "red",
                    "sort": 10,
                    "description": "Описание значения для красного цвета"
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.propertyvariant.add',
            [
                'fields' => [
                    'name' => 'Красный',
                    'orderPropsId' => 49,
                    'value' => 'red',
                    'sort' => 10,
                    'description' => 'Описание значения для красного цвета'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result":{
                "propertyVariant":{
                    "description":"Описание значения для красного цвета",
                    "id":5,
                    "name":"Красный",
                    "orderPropsId":49,
                    "sort":10,
                    "value":"red"
                }
            },
            "time":{
                "start":1711629310.006284,
                "finish":1711629310.334167,
                "duration":0.3278830051422119,
                "processing":0.024754047393798828,
                "date_start":"2024-03-28T15:35:10+03:00",
                "date_finish":"2024-03-28T15:35:10+03:00"
            }
        }

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

Название
тип

Описание

result
object

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

propertyVariant
sale_order_property_variant

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

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

201550000003

Не найдено свойство, к которому добавляется вариант значения свойства

200040300020

Недостаточно прав для добавления варианта значения свойства

100

Не указан или пустой параметр fields

0

Не переданы обязательные поля структуры fields

0

Другие ошибки (например, фатальные ошибки)

ERROR_NO_VALUE

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

ERROR_NO_NAME

Передано пустое значение названия значения варианта свойства

Статусы и коды системных ошибок

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обзор методов
Следующая
Обновить поля варианта свойства