Создать свойство элемента корзины sale.basketproperties.add

Scope: sale

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

Метод добавляет свойство для элемента (позиции) корзины в заказе.

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

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

Название
тип

Описание

fields*
object

Значения полей (подробное описание приведено ниже) для создания свойства элемента (позиции) корзины:

fields: {
            basketId: "значение",
            name: "значение",
            value: "значение",
            code: "значение",
            sort: "значение",
            xmlId: "значение",
        }

Параметр fields

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

Название
тип

Описание

basketId*
sale_basket_item.id

Идентификатор элемента (позиции) корзины заказа.
Может быть получен методами sale.basketitem.get или sale.basketitem.list

name*
string

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

value*
string

Значение свойства

code*
string

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

sort
integer

Положение в списке свойств.
Если не указать, будет присвоено значение по умолчанию — 100

xmlId
string

Внешний код свойства.
Если не указать, будет сгенерирован автоматически

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"basketId":6806,"name":"Артикул","value":"4653-4877","code":"ARTICUL"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketproperties.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"basketId":6806,"name":"Артикул","value":"4653-4877","code":"ARTICUL"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.basketproperties.add
        
try
        {
        	const response = await $b24.callMethod(
        		"sale.basketproperties.add",
        		{
        			fields: {
        				basketId: 6806,
        				name: 'Артикул',
        				value: '4653-4877',
        				code: 'ARTICUL',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.basketproperties.add',
                    [
                        'fields' => [
                            'basketId' => 6806,
                            'name'     => 'Артикул',
                            'value'    => '4653-4877',
                            'code'     => 'ARTICUL',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding basket property: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.basketproperties.add",
            {
                fields: {
                    basketId: 6806,
                    name: 'Артикул',
                    value: '4653-4877',
                    code: 'ARTICUL',
                }
            },
        )
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result);
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.basketproperties.add',
            [
                'fields' =>
                [
                    'basketId' => 6806,
                    'name' => 'Артикул',
                    'value' => '4653-4877',
                    'code' => 'ARTICUL',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "basketProperty": {
                    "basketId": 6806,
                    "code": "ARTICUL",
                    "id": 17,
                    "name": "Артикул",
                    "value": "4653-4877",
                    "xmlId": "bx_662a44cff2b81"
                }
            },
            "time": {
                "start": 1714046159.109796,
                "finish": 1714046163.282623,
                "duration": 4.1728270053863525,
                "processing": 3.4128189086914062,
                "date_start": "2024-04-25T13:55:59+02:00",
                "date_finish": "2024-04-25T13:56:03+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

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

basketProperty
sale_basket_item_property

Объект с данными созданного свойства элемента (позиции) корзины

time
time

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

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

HTTP-статус: 400

{
            "error":0,
            "error_description":"error"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

200040300010

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

200240400004

Basket item id is absent
Не указан идентификатор элемента (позиции) корзины

200240400005

Basket item id is bad
Неверный идентификатор элемента (позиции) корзины — например, строка ‘семьдесят’

200240400001, 200240400002

Не найден элемент (позиция) корзины

100

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

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

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

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

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