Добавить элемент (позицию) в корзину существующего заказа sale.basketitem.add

Scope: sale

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

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

Значения полей, отмеченных **, будут взяты из данных о товаре на сайте, если в поле productid передан реальный идентификатор товара. Если товар не существует на сайте, поле нужно заполнить самостоятельно.

Название `тип`	Описание
orderId* `sale_order.id`	Идентификатор заказа
sort `integer`	Положение в списке позиций заказа
productid* `catalog_product.id`	Идентификатор товара/вариации. Для товаров, которых нет на сайте/портале, может быть равен нулю
price `double`	Цена с учетом наценок и скидок (смотрите поле `customPrice` ниже). Поле будет заполнено автоматически, если `customPrice !== ‘Y’`
basePrice `double`	Исходная цена без учета наценок и скидок (смотрите поле `customPrice` ниже). Поле будет заполнено автоматически, если `customPrice !== ‘Y’`
discountPrice `double`	Величина итоговой скидки или наценки (смотрите поле `customPrice` ниже). Поле будет заполнено автоматически, если `customPrice !== ‘Y’`
currency* `crm_currency.CURRENCY`	Валюта цены. Должна совпадать с валютой заказа
customPrice `string`	Указана ли цена вручную. Возможные значения: `Y` — да `N` — нет Если указывается значение `Y`, то данные каталога будут игнорироваться. Необходимо явно задать параметры `price`, `basePrice` и `discountPrice` так, чтобы выполнялось условие `basePrice = price + discountPrice`
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 '{"fields":{"orderId":5147,"quantity":2,"productId":6544,"currency":"RUB"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"orderId":5147,"quantity":2,"productId":6544,"currency":"RUB"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.basketitem.add

try
        {
        	const response = await $b24.callMethod(
        		"sale.basketitem.add",
        		{
        			fields: { // минимальный набор необходимых полей
        				orderId: 5147,
        				quantity: 2,
        				productId: 6544,
        				currency: 'RUB',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.basketitem.add',
                    [
                        'fields' => [
                            'orderId'   => 5147,
                            'quantity'  => 2,
                            'productId' => 6544,
                            'currency'  => 'RUB',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding basket item: ' . $e->getMessage();
        }

BX24.callMethod(
            "sale.basketitem.add",
            {
                fields: { // минимальный набор необходимых полей
                    orderId: 5147,
                    quantity: 2,
                    productId: 6544,
                    currency: 'RUB',
                }
            },
        )
            .then(
                function(result)
                {
                    if (result.error())
                    {
                        console.error(result.error());
                    }
                    else
                    {
                        console.log(result.data());
                    }
                },
                function(error)
                {
                    console.info(error);
                }
            );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.basketitem.add',
            [
                'fields' =>
                [
                    'orderId' => 5147,
                    'quantity' => 2,
                    'productId' => 6544,
                    'currency' => 'RUB',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Частые кейсы и сценарии

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

HTTP-статус: 200

{
            "result": {
                "basketItem": {
                    "basePrice": 1000,
                    "canBuy": "Y",
                    "catalogXmlId": "FUTURE-1C-CATALOG",
                    "currency": "RUB",
                    "customPrice": "N",
                    "dateInsert": "2024-04-23T15:59:37+02:00",
                    "dateUpdate": "2024-04-23T15:59:37+02:00",
                    "dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
                    "discountPrice": 100,
                    "id": 6790,
                    "measureCode": "163",
                    "measureName": "г",
                    "name": "Товар",
                    "orderId": 5147,
                    "price": 900,
                    "productId": 1245,
                    "productXmlId": "1245",
                    "properties": [],
                    "quantity": 1,
                    "reservations": [],
                    "sort": 100,
                    "vatIncluded": "N",
                    "vatRate": null,
                    "weight": 0,
                    "xmlId": "bx_6627bec8c4fdc"
                }
            },
            "total": 1,
            "time": {
                "start": 1713880776.108755,
                "finish": 1713880777.704221,
                "duration": 1.595465898513794,
                "processing": 0.973701000213623,
                "date_start": "2024-04-23T15:59:36+02:00",
                "date_finish": "2024-04-23T15:59:37+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`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`200140400007`	`basket item is not saved - bad data` Позиция не была создана. Ошибка возникает, если передан неверный идентификатор товара или же товар неактивен
`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.add

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

Параметр fields

Примеры кода

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

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

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

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

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

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

Добавить элемент (позицию) в корзину существующего заказа sale.basketitem.add

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

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

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

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

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

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

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

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

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

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

Параметр fields

Примеры кода

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

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

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

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

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

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