Результати інших повідомлень від POS системи

Сервіс отримання налаштувань від інтеграції

post

Body

eventTimestring · date-timeRequiredExample: 2024-10-06T23:01:01.453026800Z

partnerIdstringRequiredExample: 17f71563-bcd5-4194-b973-a2183739b32c

rIDstringRequiredExample: bfe786d3ec61467ab7a17d747e7341d9

updateInfoobject[]Optional

pluginVersionintegerOptional

Інкрементальне значення, має збільшуватись з кожною новою версією

Example: 201

restaurantVersionstringRequiredExample: 7.7.0.212

restaurantLicenseDateEndstringRequiredExample: 2024.12.31

Responses

200

Подію успішно отримано та оброблено

No content

post

//api.shaketopay.com.ua/callback/versionInfo

POST //api.shaketopay.com.ua/callback/versionInfo HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 434

{
  "eventTime": "2024-10-06T23:01:01.453026800Z",
  "partnerId": "17f71563-bcd5-4194-b973-a2183739b32c",
  "rID": "bfe786d3ec61467ab7a17d747e7341d9",
  "updateInfo": [
    {}
  ],
  "pluginVersion": 201,
  "additionalInfo": {
    "info": "Коннект до ресторану о 09:12"
  },
  "restaurantVersion": "7.7.0.212",
  "implementedFeatures": [
    {
      "feature": "BILL_V_2",
      "available": true,
      "implemented": true,
      "info": {
        "orderTypeCode": 1
      }
    }
  ],
  "restaurantLicenseDateEnd": "2024.12.31"
}

200

Подію успішно отримано та оброблено

No content

Payload example /callback/versionInfo:

{
    "eventTime": "2024-10-06T23:01:01.453026800Z",
    "partnerId": "17f71563-bcd5-4194-b973-a2183739b32c",
    "rID": "bfe786d3ec61467ab7a17d747e7341d9",
    "updateInfo": [],
    "pluginVersion": 201,
    "additionalInfo": { // Сюди можна додати будь яку інформацію яку інтеграція вважає важливою до відправки.Приклад:
            "info": "Коннект до ресторану о 09:12"
    },
    "restaurantVersion": "7.7.0.212",
    "implementedFeatures": [
      {
        "feature": "BILL_V_2",
        "available": true, //Oзнака що цей функціонал налаштований (якщо це необхідно). Якщо функціонал доступний без додаткових налаштувань - передавати true
        "implemented": true //Oзнака що це функціонал реалізовано в поточній версії плагіну
      },
      {
        "feature": "STOP_LIST",
        "available": true,
        "implemented": true
      },
      {
        "feature": "ORDERS_CACHE",
        "available": true,
        "implemented": true
      },
      {
        "info": {
          "orderTypeCode": 1
        },
        "feature": "ORDER_ON_TABLE",
        "available": true,
        "implemented": true
      }
    ],
    "restaurantLicenseDateEnd": "2024.12.31"
  }


/*
 * implementedFeatures - показує реалізовані фічі в поточній версії плагіну
 * availableFeatures - показує фічі які готові до використання на поточний момнет
 *BILL_V_2, - тут ми маємо на увазі - відображення модифікаторів в чеку
 *STOP_LIST, - педача стоп лістів
 *ORDERS_CACHE - кешування рахунків
 *ORDER_ON_TABLE - замовлення за столом
 * Наприклад:
 * Функціонал замовлення за столом в ПО Rkeeper доступний з 130 версії плагіну,
 * але для того що б він працював корректно, необхідне його налаштування на кассовому сервері.
 * Об'єкт
 *  feature - ORDER_ON_TABLE
 *  implemented - true
 *  available - false
 *  info - {
 *      cashierSet:true,
 *      paymentTypeSet:false
 *  }
 *  повідомляє нам що замовлення за столом реалізовано в поточній версії плагіну, але не налаштовано тип оплати
 *  В поле info можна передати будь яку інформацію, в форматі Json.
 *  Якщо фунціонал не потребує додаткових налаштувань - передати available = implemented

Сервіс отримання меню від ресторану

post

Header parameters

restoIdstringRequired

Ідентифікатор ресторану

Body

rIDstringOptional

Ідентифікатор запиту в системі Shake To Pay

Example: Look for payload example:/callback/menuInfo

Responses

200

Запит отримно та оброблено успішно

No content

post

/callback/menuInfo

POST /callback/menuInfo HTTP/1.1
Host: api.shaketopay.com.ua
restoId: text
Content-Type: application/json
Accept: */*
Content-Length: 1688

{
  "dishes": [
    {
      "category": "text",
      "categoryId": "text",
      "description": "Фірмове блюдо",
      "groupId": "c6456aba-2f4e-410c-b2fe-03ae28896b98",
      "groupModifiers": [
        {
          "childModifiers": [
            {
              "defaultAmount": 1,
              "id": "d7f7b5cb-2675-4273-bd70-77ad6ec7977d",
              "maxAmount": 2,
              "minAmount": 1,
              "required": false
            }
          ],
          "childModifiersHaveMinMaxRestrictions": true,
          "defaultAmount": 1,
          "free": true,
          "freeAmount": 3,
          "id": "d7f7b5cb-2675-4273-bd70-77ad6ec7977d",
          "maxAmount": 2,
          "minAmount": 1,
          "required": false
        }
      ],
      "id": "9b4f3e6c-71b5-479f-88d5-61c6739c939a",
      "isActive": true,
      "menuSections": [
        "text"
      ],
      "modifierSchemeId": "text",
      "modifiers": [
        {
          "defaultAmount": 1,
          "freeAmount": 3,
          "id": "d7f7b5cb-2675-4273-bd70-77ad6ec7977d",
          "maxAmount": 2,
          "minAmount": 1,
          "required": false
        }
      ],
      "name": "Піца Гавайська",
      "price": 5.1573,
      "scale": {
        "defaultSize": {
          "id": "text",
          "kitchenName": "text",
          "menuIndex": 1,
          "name": "text"
        },
        "id": "text",
        "name": "text"
      },
      "taxCategory": "text",
      "taxCategoryId": "text",
      "type": "Dish",
      "unit": "кг.",
      "vendorCode": "text"
    }
  ],
  "groupModifiers": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "groups": [
    {
      "id": "c6456aba-2f4e-410c-b2fe-03ae28896b98",
      "menuIndex": 3,
      "name": "Другі страви",
      "parentId": "132d2699-a6ec-44fc-8ef7-8dd943990817"
    }
  ],
  "modifiers": [
    {
      "category": "text",
      "categoryId": "text",
      "description": "к нашему фирменному блюду",
      "groupId": "202f056a-6a35-46b4-8952-3508af724764",
      "id": "f14da21a-5be9-4736-9ece-420bd310bc8a",
      "isActive": true,
      "name": "Ветчина",
      "price": 20.3629,
      "scale": {
        "defaultSize": {
          "id": "text",
          "kitchenName": "text",
          "menuIndex": 1,
          "name": "text"
        },
        "id": "text",
        "name": "text"
      },
      "taxCategory": "text",
      "taxCategoryId": "text",
      "unit": "кг.",
      "vendorCode": "text"
    }
  ],
  "rID": "Look for payload example:/callback/menuInfo"
}

200

Запит отримно та оброблено успішно

No content

Payload example:/callback/menuInfo

JSON

{
   "dishes":[
      {
         "category":"string",
         "categoryId":"string",
         "description":"Фірмове блюдо",
         "groupId":"c6456aba-2f4e-410c-b2fe-03ae28896b98",
         "groupModifiers":[
            {
               "childModifiers":[
                  {
                     "defaultAmount":1,
                     "id":"d7f7b5cb-2675-4273-bd70-77ad6ec7977d",
                     "maxAmount":2,
                     "minAmount":1,
                     "required":false
                  }
               ],
               "childModifiersHaveMinMaxRestrictions":true,
               "defaultAmount":1,
               "free":true,
               "freeAmount":3,
               "id":"d7f7b5cb-2675-4273-bd70-77ad6ec7977d",
               "maxAmount":2,
               "minAmount":1,
               "required":false
            }
         ],
         "id":"9b4f3e6c-71b5-479f-88d5-61c6739c939a",
         "isActive":true,
         "menuSections":[
            "string"
         ],
         "modifierSchemeId":"string",
         "modifiers":[
            {
               "defaultAmount":1,
               "freeAmount":3,
               "id":"d7f7b5cb-2675-4273-bd70-77ad6ec7977d",
               "maxAmount":2,
               "minAmount":1,
               "required":false
            }
         ],
         "name":"Піца Гавайська",
         "price":5.1573,
         "scale":{
            "defaultSize":{
               "id":"string",
               "kitchenName":"string",
               "menuIndex":0,
               "name":"string"
            },
            "id":"string",
            "name":"string"
         },
         "taxCategory":"string",
         "taxCategoryId":"string",
         "type":"Dish",
         "unit":"кг.",
         "vendorCode":"string"
      }
   ],
   "groupModifiers":[
      {
         "id":"string",
         "name":"string"
      }
   ],
   "groups":[
      {
         "id":"c6456aba-2f4e-410c-b2fe-03ae28896b98",
         "menuIndex":3,
         "name":"Інші  страви",
         "parentId":"132d2699-a6ec-44fc-8ef7-8dd943990817"
      }
   ],
   "modifiers":[
      {
         "category":"string",
         "categoryId":"string",
         "description":"к нашему фирменному блюду",
         "groupId":"202f056a-6a35-46b4-8952-3508af724764",
         "id":"f14da21a-5be9-4736-9ece-420bd310bc8a",
         "isActive":true,
         "name":"Ветчина",
         "price":20.3629,
         "scale":{
            "defaultSize":{
               "id":"string",
               "kitchenName":"string",
               "menuIndex":0,
               "name":"string"
            },
            "id":"string",
            "name":"string"
         },
         "taxCategory":"string",
         "taxCategoryId":"string",
         "unit":"кг.",
         "vendorCode":"string"
      }
   ]
}

PreviousКешування рахунків NextПідключення за допомогою Postman

Last updated 10 months ago