gamification.shop.product.create
Scope:
gamificationКто может вызывать: Только admin или manager. Подробнее: Права доступа
Создать новый товар в магазине бонусов.
HTTP: POST
Побочные эффекты: добавляет элемент в инфоблок товаров магазина.
Параметры метода
Поля передаются через параметр fields (объект) либо напрямую:
| Поле / псевдоним | Тип | Обяз. | Описание |
|---|---|---|---|
fields.NAME / name |
string |
да | Название товара |
fields.PRICE / price |
int |
да | Цена в BAL |
fields.ACTIVE / active |
string |
нет | Активность: Y / N |
fields.SECTIONS / sections |
int[] |
нет | ID категорий |
fields.SORT / sort |
int |
нет | Порядок сортировки |
fields.PREVIEW_TEXT / previewText |
string |
нет | Краткое описание |
fields.QUANTITY / quantity |
int |
нет | Общий запас |
fields.AVAILABLE_QUANTITY / availableQuantity |
int |
нет | Доступное количество |
fields.IS_QUANTITY / isQuantity |
string |
нет | Учёт запаса: Y / N |
fields.ENABLE_SELLING / enableSelling |
string |
нет | Продажи включены: Y / N |
fields.ACTIVE_FROM / activeFrom |
string |
нет | Дата начала активности |
fields.ACTIVE_TO / activeTo |
string |
нет | Дата окончания активности |
Возвращаемые данные
result.result — объект созданного товара.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Вызывающий не является admin/manager |
VALIDATION_ERROR |
Не переданы поля или fields не является объектом |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.shop.product.create.json" \
-H "Content-Type: application/json" \
-d '{
"fields": {
"NAME": "Кофе",
"PRICE": 100,
"ACTIVE": "Y",
"ENABLE_SELLING": "Y"
}
}'
Пример ответа:
{
"result": {
"result": {
"ID": "5",
"NAME": "Кофе",
"PRICE": "100",
"ACTIVE": "Y"
},
"total": null,
"next": null,
"error": null
}
}
Предыдущая
Следующая