метод REST scope: sale

sale.basketitem.addCatalogProduct

Добавить позицию с товаром или услугой из модуля catalog в корзину существующего заказа

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

Описание

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

Параметры

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

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

Параметр fields

orderId sale_order.id обязательный

Идентификатор заказа. Может быть указан только при создании позиции корзины.

Должен быть получен ранее методами sale.order.add или sale.order.list

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 — цена получена из каталога товаров

По умолчанию значение N.

Если указывается значение Y, то данные цены из каталога будут игнорироваться. Необходимо явно задать параметры price, basePrice и discountPrice так, чтобы выполнялось условие basePrice = price + discountPrice

quantity double обязательный

Количество товара

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

Внешний код позиции корзины

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

Название товара

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":5147,"quantity":1,"productId":4347,"currency":"RUB"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.addCatalogProduct

Ответ

HTTP-статус: 200

{
    "result": {
        "basketItem": {
            "basePrice": 1234,
            "canBuy": "Y",
            "catalogXmlId": "FUTURE-ERP-CATALOG",
            "currency": "RUB",
            "customPrice": "N",
            "dateInsert": "2024-04-22T16:36:43+02:00",
            "dateUpdate": "2024-04-22T16:36:43+02:00",
            "dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
            "discountPrice": 124,
            "id": 6784,
            "measureCode": "796",
            "measureName": "шт",
            "name": "Услуга2",
            "orderId": 5147,
            "price": 1110,
            "productId": 4347,
            "productXmlId": "4347",
            "properties": [],
            "quantity": 1,
            "reservations": [],
            "sort": 100,
            "type": 2,
            "vatIncluded": "N",
            "vatRate": null,
            "weight": 0,
            "xmlId": "bx_662675fba6516"
        }
    },
    "total": 1,
    "time": {
        "start": 1713796602.830767,
        "finish": 1713796604.315251,
        "duration": 1.4844841957092285,
        "processing": 0.6749260425567627,
        "date_start": "2024-04-22T16:36:42+02:00",
        "date_finish": "2024-04-22T16:36:44+02:00",
        "operating": 0
    }
}

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

result object

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

basketItem sale_basket_item

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

total integer

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

time time

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

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

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}
Код Описание Значение
200140400006 Module catalog is not exists

Отсутствует модуль Торговый каталог (catalog)

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 Другие ошибки (например, фатальные ошибки)

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

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