CreateDiscount
| Назначение | Создание скидки |
|---|---|
| PluggetSystemType | RKRef |
Формат запроса
{
"taskType": "CreateDiscount",
"params": {
"sync": {
"objectId": number,
"timeout": number
},
"guid": "string",
"name": "string",
"type": "string",
"applyWithOther": bool,
"applyOnMarkups": bool,
"isOpenValue": bool,
"maxSum": number,
"maxPercent": number,
"discountDetails": [
{ "amount": number }
]
}
}
| Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
|---|---|---|---|---|
| taskType | string | да | Тип задачи | |
| sync | Синхронный вызов метода (либо синхронный, либо асинхронный) | |||
| int | да | Код ресторана в системе лицензирования | |
| int | - | Время ожидания ответа в секундах | 120 секунд |
| guid | guid | да | Guid новой скидки | |
| name | string | да | Наименование скидки | |
| type | string | да | Тип скидки (Amount - сумма, Percent - процент ) | |
| applyWithOther | boolean | да | На заказ | |
| applyOnMarkups | boolean | да | Действует на наценки | |
| isOpenValue | boolean | - | Изменяемое значение | |
| maxSum | number | да | Максимальная сумма (для типа Amount) | |
| maxPercent | number | да | Максимальный процент (для типа Percent) | |
| discountDetails | array | да | Массив детализаций скидки | |
| number | да | Значение скидки |
Формат ответа
{
"taskResponse": {
"isOk": true,
"discount": {
"name": "string",
"type": string,
"status": "string"
}
},
"responseCommon": {
"taskGuid": "58cc115d-86ca-41ec-aea4-140aa7095bad",
"taskType": "CreateDiscount",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}
| Параметр | Тип | Описание |
|---|---|---|
| responseCommon | object | Информация по задаче |
| guid | Уникальный код этой задачи используется при получении задачи через очередь |
| string | Тип задачи |
| int | Код ресторана в системе лицензирования |
| taskResponse | object | |
| bool | Блюдо создан или нет |
| object | Созданная скидки |
| string | Наименование скидки. |
| string | Тип скидки (Amount - сумма, Percent - процент ) |
| string | Статус в RKeeper |
| error | object | Контейнер ошибок, см Описание ошибок |
Пример запроса
{
"taskType": "CreateDiscount",
"params": {
"sync": {
"objectId": {{ObjectId}},
"timeout": 120
},
"guid": "6de2415e-9492-4d86-81b3-6713ba3b2235",
"name": "Тест Percent",
"type": "Percent",
"applyWithOther": false,
"applyOnMarkups": false,
"isOpenValue": false,
"maxSum": 1000,
"maxPercent": 10,
"discountDetails": [
{ "amount": 5.5 },
{ "amount": 37.5 }
]
}
}
Пример успешного ответа
{
"taskResponse": {
"isOk": true,
"discount": {
"name": "Тест Percent",
"status": "Active",
"type": "Percent"
}
},
"responseCommon": {
"taskGuid": "62e2702f-f1d4-4783-ac45-55037f7f74ef",
"taskType": "CreateDiscount",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}
Пример ответа с ошибкой
{
"taskResponse": {
"isOk": false,
"error": "Скидка/наценка с Guid = {6DE2415E-9492-4D86-81B3-6713BA3B2235} уже существует",
"discount": {
"name": "Тест Percent",
"status": "Active",
"type": "Percent"
}
},
"responseCommon": {
"taskGuid": "5dba0151-ccb1-4bec-ab6f-e9ffd2eb709d",
"taskType": "CreateDiscount",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}