метод REST scope: sale

sale.basketitem.add

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

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

Описание

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

Параметры

fields object обязательный

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

Параметр fields

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 обязательный

Ставка налога долей от единицы: 0.1 — это 10 %. Для указания ставки «Без НДС» нужно передать пустую строку

vatIncluded string обязательный

Флаг того, включен ли НДС или налог в цену товара. Возможные значения:
- Y — да
- N — нет

catalogXmlId string обязательный

Внешний код каталога товаров

productXmlId string обязательный

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

Примеры запроса

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

Ответ

HTTP-статус: 200

{
    "result": {
        "basketItem": {
            "basePrice": 1000,
            "canBuy": "Y",
            "catalogXmlId": "FUTURE-ERP-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"
}
Код Описание Значение
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 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.