Обновить привязку элемента корзины к оплате sale.paymentitembasket.update

Scope: sale

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

Метод обновляет привязку элемента корзины к оплате.

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

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

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

Параметр fields

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

Название `тип`	Описание
quantity* `double`	Количество товара
xmlId `string`	Внешний идентификатор записи

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1186,"fields":{"quantity":1,"xmlId":"myNewXmlId"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paymentitembasket.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1186,"fields":{"quantity":1,"xmlId":"myNewXmlId"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paymentitembasket.update

try
        {
        	const response = await $b24.callMethod(
        		'sale.paymentitembasket.update', {
        			id: 1186,
        			fields: {
        				quantity: 1,
        				xmlId: 'myNewXmlId',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paymentitembasket.update',
                    [
                        'id' => 1186,
                        'fields' => [
                            'quantity' => 1,
                            'xmlId' => 'myNewXmlId',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating payment item basket: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.paymentitembasket.update', {
                id: 1186,
                fields: {
                    quantity: 1,
                    xmlId: 'myNewXmlId',
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.paymentitembasket.update',
            [
                'id' => 1186,
                'fields' =>
                [
                    'quantity' => 1,
                    'xmlId' => 'myNewXmlId',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result":{
                "paymentItemBasket":{
                    "basketId":2722,
                    "dateInsert":"2024-04-17T09:37:45+03:00",
                    "id":1186,
                    "paymentId":1025,
                    "quantity":1,
                    "xmlId":"myNewXmlId"
                }
            },
            "time":{
                "start":1713341342.331169,
                "finish":1713341343.013559,
                "duration":0.6823902130126953,
                "processing":0.4167962074279785,
                "date_start":"2024-04-17T11:09:02+03:00",
                "date_finish":"2024-04-17T11:09:03+03:00"
            }
        }

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

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

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

HTTP-статус: 400

{
            "error":201240400001,
            "error_description":"payment item is not exists"
        }

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

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

Код	Описание
`201240400001`	Обновляемая привязка элемента корзины к оплате не найдена
`200040300020`	Недостаточно прав для обновления привязки элемента корзины к оплате
`100`	Не указан параметр `id`
`100`	Не указан или пустой параметр `fields`
`0`	Не переданы обязательные поля структуры `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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить привязку элемента корзины к оплате

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

Обновить привязку элемента корзины к оплате sale.paymentitembasket.update

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

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

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

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

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

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

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

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

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