latestSwagger 2.02026-08-10119.3 KB

aeab61af099c

Bill Events

Відправка вебхука при отриманні фінального статусу замовлення.

post//api.shaketopay.com.ua/callback/webhook

Headers

restoIdstring required

Restaurant ID

Request body

webhookTypestring required
eventTimestring date-time required
orderIdstring required
tableNumberinteger required
closeTimestring required
openTimestring required
orderNumberinteger required
resultSumnumber float required
orderStatusstring required
totalSumnumber float required
waiterIdstring required
waiterstring required
isBanquetOrderboolean required
isDeliveryboolean required
bonusSumnumber float required
splitAvailableboolean required
rewardAvailableboolean required
billTimestring required
paidSumnumber float required
discountSumnumber float required
tableIdstring required
pricingTimestring
versioninteger required
orderTypestring required

Example request

{
  "webhookType": "BILL_CLOSED",
  "eventTime": "2024-09-30T15:29:04.9036828Z",
  "orderId": "492fa768-2fb0-4b30-9f5a-db9c17db3fff",
  "tableNumber": 1,
  "closeTime": "2024.09.30 18:28:59",
  "openTime": "2024.09.30 18:27:46",
  "orderNumber": 133264,
  "resultSum": 140,
  "orderStatus": "Closed",
  "totalSum": 140,
  "waiterId": "0ab41df0-f4ae-4fbe-959f-ecaba7c85c85",
  "waiter": "Максимейко Наталія",
  "discounts": {
    "list": [
      {
        "id": "1002291",
        "name": "Скидка 10% на чек",
        "sum": 8.6,
        "code": 6
      }
    ]
  },
  "guests": [
    {
      "name": "Гість 0",
      "id": "91ed5c34-85b2-4c54-a001-0f9e040d0004",
      "dishes": [
        {
          "positionId": "127aaa1a-7fce-4ddc-95af-7af102eecc08",
          "name": "Макаронс ",
          "count": 1,
          "sum": 70,
          "price": 70,
          "categoryId": "2e2e28fc-bbfd-ee15-018f-9687de9ed540",
          "category": "Десерти Кебчук",
          "orderNumber": 133264,
          "type": "dish",
          "dishId": "68591915-9a42-4fe8-84fa-a10a9fbbd6a2",
          "rawSum": 70,
          "additionalInfo": {
            "system": "syrve",
            "course": 1,
            "status": "Served"
          }
        }
      ]
    }
  ],
  "rewardAvailable": true,
  "billTime": "2024.09.30 18:28:59",
  "paidSum": 140,
  "tableId": "e6ad6ef3-bbdb-41c4-8fd3-dd0691142074",
  "version": 1865768,
  "payments": [
    {
      "paymentTypeName": "Готівка",
      "sum": 140,
      "paymentTypeKind": "Cash",
      "additionalInfo": {
        "system": "syrve",
        "externalId": "5b28a833-ba81-41d9-83a2-2cef3189d882",
        "status": "Processed",
        "typeId": "09322f46-578a-d210-add7-eec222a08871"
      }
    }
  ],
  "additionalInfo": {
    "system": "syrve",
    "tablesDetails": [
      {
        "externalId": "e6ad6ef3-bbdb-41c4-8fd3-dd0691142074",
        "number": 1,
        "isActive": true
      }
    ],
    "waiterDetails": [
      {
        "externalId": "0ab41df0-f4ae-4fbe-959f-ecaba7c85c85",
        "name": "Максимейко Наталія",
        "phone": "+380997716858",
        "pinCode": "АК00-00043"
      }
    ]
  },
  "orderType": "Common"
}

Response

Request received and processed successfully