Изменить свойство элемента корзины sale.basketproperties.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: администратор
Метод sale.basketproperties.update изменяет свойство для элемента корзины в заказе.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор свойства элемента (позиции) корзины. |
|
|
fields* |
Значения изменяемых полей (подробное описание приведено ниже) свойства элемента (позиции) корзины:
|
Параметр fields
Обязательные параметры отмечены *
Поля name, value и code передавайте при каждом вызове, даже если меняете только одно из них. Строковые поля хранят до 255 символов: более длинное значение Битрикс24 обрежет без ошибки.
|
Название |
Описание |
|
name* |
Название свойства |
|
value* |
Значение свойства |
|
code* |
Символьный код свойства |
|
sort |
Положение в списке свойств |
|
xmlId |
Внешний код свойства |
Перенести свойство на другую позицию корзины нельзя. Если передать в fields новый basketId, метод не вернет ошибку, но свойство останется у прежней позиции. Чтобы свойство появилось у нужной позиции, удалите его методом sale.basketproperties.delete и создайте заново методом sale.basketproperties.add.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":17,"fields":{"name":"Артикул","value":"123-456-789","code":"ARTICUL"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketproperties.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":17,"fields":{"name":"Артикул","value":"123-456-789","code":"ARTICUL"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketproperties.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type BasketPropertyUpdateResult = {
basketProperty: {
basketId: number
code: string
id: number
name: string
sort: number
value: string
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<BasketPropertyUpdateResult>({
method: 'sale.basketproperties.update',
params: {
id: 17,
fields: {
name: 'Articul',
value: '123-456-789',
code: 'ARTICUL',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.basketProperty)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateBasketProperty() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.basketproperties.update',
params: {
id: 17,
fields: {
name: 'Articul',
value: '123-456-789',
code: 'ARTICUL',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.basketProperty)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateBasketProperty)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"name": "Артикул",
"value": "123-456-789",
"code": "ARTICUL",
}
try:
bitrix_response = client.sale.basketproperties.update(
bitrix_id=17,
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'sale.basketproperties.update',
[
'id' => 17,
'fields' => [
'name' => 'Артикул',
'value' => '123-456-789',
'code' => 'ARTICUL',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating basket properties: ' . $e->getMessage();
}
BX24.callMethod(
"sale.basketproperties.update",
{
id: 17,
fields: {
name: 'Артикул',
value: '123-456-789',
code: 'ARTICUL',
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.basketproperties.update',
[
'id' => 17,
'fields' =>
[
'name' => 'Артикул',
'value' => '123-456-789',
'code' => 'ARTICUL',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.basketproperties.update", b24.Params{
"id": 17,
"fields": b24.Params{
"name": "Артикул",
"value": "123-456-789",
"code": "ARTICUL",
},
})
if err != nil {
return fmt.Errorf("sale.basketproperties.update: %w", err)
}
// Метод заворачивает ответ в объект с ключом "basketProperty".
raw, ok := b24.Unwrap(res.Result, "basketProperty")
if !ok {
return fmt.Errorf("в ответе нет ключа basketProperty")
}
var item struct {
BasketID b24.ID `json:"basketId"`
Code string `json:"code"`
ID b24.ID `json:"id"`
Name string `json:"name"`
Sort int `json:"sort"`
Value string `json:"value"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.BasketID, item.Code)
Обработка ответа
HTTP-статус: 200
{
"result": {
"basketProperty": {
"basketId": 6806,
"code": "ARTICUL",
"id": 17,
"name": "Артикул",
"sort": 100,
"value": "123-456-789",
"xmlId": "bx_662a44cff2b81"
}
},
"total": 1,
"time": {
"start": 1714049553.754992,
"finish": 1714049555.158799,
"duration": 1.4038069248199463,
"processing": 0.67576003074646,
"date_start": "2024-04-25T14:52:33+02:00",
"date_finish": "2024-04-25T14:52:35+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
basketProperty |
Объект с данными измененного свойства элемента (позиции) корзины |
|
total |
Число обработанных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Required fields: name, code"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Свойства корзины в Интернет-магазине: обзор методов
- Создать свойство элемента корзины sale.basketproperties.add
- Получить значение свойства корзины sale.basketproperties.get
- Получить список свойств корзины sale.basketproperties.list
- Удалить свойство корзины sale.basketproperties.delete
- Получить поля элементов свойств корзины sale.basketproperties.getFields