Изменить позицию корзины существующего заказа sale.basketitem.update

Scope: sale

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

Метод изменяет позицию корзины существующего заказа.

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

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

Название `тип`	Описание
id* `sale_basket_item.id`	Идентификатор позиции заказа
fields* `object`	Значения изменяемых полей

Параметр fields

Название `тип`	Описание
sort `integer`	Положение в списке позиций заказа
price `double`	Цена с учетом наценок и скидок
basePrice `double`	Исходная цена без учета наценок и скидок
discountPrice `double`	Величина итоговой скидки или наценки
quantity `double`	Количество товара
xmlId `string`	Внешний код позиции корзины
name `string`	Название товара
weight `integer`	Вес товара
dimensions `string`	Размеры товара (сериализованный массив)
measureCode `catalog_measure.code`	Код единицы измерения товара
measureName `catalog_measure.symbol`	Название единицы измерения
canBuy `string`	Флаг доступности товара. Возможные значения: `Y` — да `N` — нет
vatRate `double`	Величина налога в процентах. Для указания ставки «Без НДС» нужно передать пустую строку
vatIncluded `string`	Флаг того, включен ли НДС или налог в цену товара. Возможные значения: `Y` — да `N` — нет
catalogXmlId `string`	Внешний код каталога товаров
productXmlId `string`	Внешний код товара

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6791,"fields":{"quantity":7,"price":10,"discountPrice":990}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6791,"fields":{"quantity":7,"price":10,"discountPrice":990},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.basketitem.update

try
        {
        	const response = await $b24.callMethod(
        		"sale.basketitem.update",
        		{
        			id: 6791,
        			fields: {
        				quantity: 7,
        				price: 10,
        				discountPrice: 990,
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.basketitem.update',
                    [
                        'id' => 6791,
                        'fields' => [
                            'quantity'      => 7,
                            'price'         => 10,
                            'discountPrice' => 990,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating basket item: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.basketitem.update",
            {
                id: 6791,
                fields: {
                    quantity: 7,
                    price: 10,
                    discountPrice: 990,
                }
            },
        )
            .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.basketitem.update',
            [
                'id' => 6791,
                'fields' =>
                [
                    'quantity' => 7,
                    'price' => 10,
                    'discountPrice' => 990,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "basketItem": {
                    "basePrice": 1000,
                    "canBuy": "Y",
                    "catalogXmlId": "",
                    "currency": "RUB",
                    "customPrice": "Y",
                    "dateInsert": "2024-04-23T18:51:28+02:00",
                    "dateUpdate": "2024-04-24T14:02:25+02:00",
                    "dimensions": "a:3:{s:5:\"WIDTH\";i:244;s:6:\"HEIGHT\";i:100;s:6:\"LENGTH\";i:31;}",
                    "discountPrice": 990,
                    "id": 6791,
                    "measureCode": "768",
                    "measureName": "шт",
                    "name": "Пробный товар",
                    "orderId": 5147,
                    "price": 10,
                    "productId": 0,
                    "productXmlId": "ProductKey",
                    "properties": [],
                    "quantity": 7,
                    "reservations": [],
                    "sort": 400,
                    "type": null,
                    "vatIncluded": "Y",
                    "vatRate": 10,
                    "weight": 40,
                    "xmlId": "BasketPositionId"
                }
            },
            "total": 1,
            "time": {
                "start": 1713960144.842687,
                "finish": 1713960146.089664,
                "duration": 1.2469770908355713,
                "processing": 0.5501749515533447,
                "date_start": "2024-04-24T14:02:24+02:00",
                "date_finish": "2024-04-24T14:02:26+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
basketItem `sale_basket_item`	Объект с данными обновленного элемента (позиции) корзины
total `integer`	Число обработанных записей
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

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

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

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

Код	Описание
`200140400001`	`basket item is not exists` Не найдена позиция корзины
`200140400008`	`Required fields: fields[ORDER_ID]` Не указан идентификатор заказа
`200140400009`	`Order not found` Заказ не найден
`200140400011`	`Currency must be the currency of the order` Валюта позиции не совпадает с валютой заказа
`200040300010`	Недостаточно прав для изменения
`100`	Не указаны обязательные параметры
`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.basketitem.update

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

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

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

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

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

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

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

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

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