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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sale

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

Метод sale.basketproperties.update изменяет свойство для элемента корзины в заказе.

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

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

Название
тип

Описание

id*
sale_basket_item_property.id

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

fields*
object

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

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

Параметр fields

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

Поля name, value и code передавайте при каждом вызове, даже если меняете только одно из них. Строковые поля хранят до 255 символов: более длинное значение Битрикс24 обрежет без ошибки.

Название
тип

Описание

name*
string

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

value*
string

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

code*
string

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

sort
integer

Положение в списке свойств

xmlId
string

Внешний код свойства

Перенести свойство на другую позицию корзины нельзя. Если передать в 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
object

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

basketProperty
sale_basket_item_property

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

total
integer

Число обработанных записей

time
time

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Required fields: name, code"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

0

Required fields: name, code — в fields не переданы обязательные поля name, value или code. Имена пропущенных полей перечислены в error_description

200240400003

basket property is not exists — свойства с таким id нет

100

Could not find value for parameter {fields} — не передан параметр fields

100

Bitrix\Sale\BasketPropertyItem constructor must be is public — не передан параметр id

200040300020

Access Denied — недостаточно прав для изменения

0

Другие ошибки (например, фатальные ошибки)

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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