НазначениеСоздание скидки
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 }
      ]  
 }
}
ПараметрТипОбязательныйОписаниеЗначение по умолчанию
taskTypestringдаТип задачи
sync

Синхронный вызов метода (либо синхронный, либо асинхронный)
  • objectId
intдаКод ресторана в системе лицензирования
  • timeout
int-Время ожидания ответа в секундах120 секунд
guidguidдаGuid новой скидки
namestringдаНаименование скидки
typestringдаТип скидки (Amount - сумма, Percent - процент )
applyWithOtherbooleanдаНа заказ
applyOnMarkupsbooleanдаДействует на наценки
isOpenValueboolean-Изменяемое значение
maxSumnumberдаМаксимальная сумма (для типа Amount)
maxPercentnumberдаМаксимальный процент (для типа Percent)
discountDetailsarrayдаМассив детализаций скидки
  • amount
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"
    }
}
ПараметрТипОписание
responseCommonobjectИнформация по задаче
  • taskGuid
guidУникальный код этой задачи используется при получении задачи через очередь
  • taskType
stringТип задачи
  • objectId
intКод ресторана в системе лицензирования
taskResponseobject
  • isOk
boolБлюдо создан или нет 
  • discount
objectСозданная скидки
    • name
stringНаименование скидки. 
    • type
stringТип скидки (Amount - сумма, Percent - процент ) 
    • status
stringСтатус в RKeeper
errorobjectКонтейнер ошибок, см Описание ошибок

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

{
  "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"
    }
}