API Restoplace. Инструкция для разработчиков

Метод позволяет получить список резервов адреса

Запрос

Параметры

Ответ

• • application/json

Метод позволяет получить данные конкретного резерва адреса по уникальному id

Запрос

Параметры

Успешный ответ

• • — Если создан резерв с выбранным столом:

    {
      "method":"reserves",
      "requestDate":1716998092,
      "responseData":{
        "id":"145248",  /* id резерва */
        "number":"107", 
        "message":"Резерв создан"  },
      "page":1,
      "totalPages":1   
    }     
    

  • — Если создана заявка в Листе ожидания:

    {
      "method":"reserves",
      "requestDate":1716998092,
      "responseData":{
        "id":"145248", /* id резерва */
        "number":"107", 
        "message":"Заявка добавлена в Лист ожидания"  },
      "page":1,
      "totalPages":1   
    }

  • — Если создана заявка или резерв с необходимостью внесения онлайн оплаты:

    {
      "method":"reserves",
      "requestDate":1716998092,
      "responseData":{
        "id":"145248", /* id резерва */ 
                    "number":"107", 
                  "message":"Ожидание оплаты",
        "paymentNeed":true, /* необходимо произвести оплату */
        "paymentLink":"https://acquiring.bank.com/pay"/* ссылка на страницу оплаты. Ссылка может не сформироваться, если интернет эквайринг настроен некорректно */ 
        "paymentPrice":"1000", /* сумма оплаты */ 
        "paymentWaitMinutes":"40", /* время ожидания оплаты, в минутах */ 
        "paymentWaitTo":"2025-08-28 18:27:21", /* до скольки будет активна ссылка на оплату */ 
      },
      "page":1,
      "totalPages":1   
    }
    

Ответ с ошибкой

• • {
      "error":"Нет свободных столов на выбранное время для 2 персон"   
    }
    

Запрос

Параметры

Успешный ответ

• • — Если создан резерв с выбранным столом:

    {
      "method":"reserves",
      "requestDate":1716998092,
      "responseData":{
        "id":"175997",  /* id резерва */
        "number":"6458", 
        "message":"Резерв обновлен"  },
      "page":1,
      "totalPages":1   }     
    

Ответ с ошибкой

• • {
      "error":"Стол №2: Данный период времени занят"   }
    

Метод позволяет изменить статус резерва. При отмене резерва (status=5 или status=6) можно опционально указать причину отмены.

Запрос

Параметры

Успешный ответ

• {
    "method":"reserves",
    "requestDate":1738512000,
    "responseData":{
      "id":12345,
      "message":"Резерв обновлен" 
   },
    "page":1,
    "totalPages":1  
  }

Ответ с ошибкой

• • {
      "error":"Неверный статус"
    }

Метод позволяет получить список доступных причин отмены резерва. Используется для отображения списка причин в интерфейсе перед отменой бронирования

Пример ответа

• {
    "method":"reserves",
    "requestDate":1738512000,
    "responseData":[
      {"id":1, "text":"Другая причина", "requires_text":true},
      {"id":2, "text":"Гость не пришёл (No-show)", "requires_text":false},
      {"id":3, "text":"Гость отменил сам", "requires_text":false},
      {"id":4, "text":"Не удалось связаться", "requires_text":false},
      {"id":5, "text":"Гость опоздал", "requires_text":false},
      {"id":6, "text":"Перенос на другую дату", "requires_text":false},
      {"id":7, "text":"Дублирующая бронь", "requires_text":false},
      {"id":8, "text":"Отказ от условий/депозита", "requires_text":false},
      {"id":9, "text":"Заведение не работает", "requires_text":false},
      {"id":10, "text":"Ошибка при создании брони", "requires_text":false},
      {"id":11, "text":"Некорректные данные", "requires_text":false}
    ],
    "page":1,
    "totalPages":1  
  }

Поля ответа

Использование

Полученные значения `id` используются в методе `PUT /reserves/{id}/status` в параметре `cancel_reason` при отмене резерва

Запрос

Параметры

В ответ получаете объект с рассчитанным депозитом, с полями:

• • • 
      {
        "method": "deposit",
        "requestDate": 1762450323,
        "responseData": {
          "deposit": 1000 /* депозит за выбранные столы / лист ожидания */,
          "depositTotal": 1430 /* итоговый депозит с чаевыми и налогами */,
          "depositTip": 240 /* чаевые */,
          "depositTax": 190 /* налог */,
          "depositText": "" /* описание */
        },
        "page": 1,
        "totalPages": 1
      }
      

Запрос

Параметры

В ответ получаете список слотов, с полями:

• • • {
      	"method":"times",
      	"requestDate":1717098170,
      	"responseData":[
      		{
      			"from":"2024-05-31 00:00:00", /* начало слота */
      			"to":"2024-05-31 01:00:00", /* конец слота */
      			"free":true, /* есть ли вообще свободный стол в данном промежутке времени слота (false/true) */
      			"counts":{
      				"1":"busy", /* нет свободных столиков */
      				"2":"free", /* есть свободный столик или столики */
      				"3":"free",
      				"4":"free",
      				"5":"free",
      				"6":"free" },
      			"free_tables":{ 
      				"2":["1542", "1543", "2460"],
      				"3":["1542", "1543", "2460"],
      				"4":["1542", "1543", "2460"],
      				"5":["1542"],
      				"6":["1542"]
      			}
      		},
      		{
      			"from":"2024-05-31 01:00:00",
      			"to":"2024-05-31 02:00:00",
      			"free":true,
      			"counts":{
      				"1":"busy",
      				"2":"free",
      				"3":"free",
      				"4":"free",
      				"5":"free",
      				"6":"free" },
      			"free_tables":{ /* id свободных столиков */
      				"2":["1542", "1543", "2460"],
      				"3":["1542", "1543", "2460"],
      				"4":["1542", "1543", "2460"],
      				"5":["1542"],
      				"6":["1542"]
      			}
      		},
      	],
      	"page":1,
      	"totalPages":1 
      }
      

Запрос

Параметры

Метод позволяет получить список объектов бронирования (столы, стулья, бильярд, беседка, дом, компьютер и т. д.)

Запрос

Параметры

Метод позволяет получить данные конкретного объекта бронирования по уникальному id

Запрос

Параметры

Метод позволяет получить список залов

Запрос

Параметры

Метод позволяет получить данные конкретного зала по уникальному id

В ответ получаете :

• • • 
      	{
      		"method":"info",
      		"requestDate":1760706127,
      		"responseData":{
      			"address":{
      				"id":"111",
      				"orgid":"100",
      				"city":"Казань",
      				"address":"Пр. Московский, д.102",
      				"time_zone":"Europe/Moscow",
      				"time_now":"2028-10-17 16:02:07",
      				"UTC":"+03:00" },
      			"organization":{
      				"id":"100",
      				"name":"Ваше Заведение",
      				"subdomain":"test",
      				"widget":"test.restoplace.ws" },
      			"apikey":{
      				"type":"api" }
      		},
      		"page":1,
      		"totalPages":1
      	}
       

Метод позволяет получить список событий адреса

Запрос

Параметры

Пример ответа:

• • • 
      {
        "method": "events",
        "requestDate": 1760706127,
        "responseData": [
          {
            "id": 1,
            "userid": 100,
            "checked": 1,
            "priority": 1,
            "created": "2025-01-15 12:00:00",
            "last_updated": "2025-01-15 14:30:00",
            "name": "Живая музыка",
            "text": "Описание события",
            "time_from": "2025-01-20 19:00:00",
            "time_to": "2025-01-20 23:00:00",
            "price": 1500,
            "count": 50,
            "number": 10,
            "langs_text": {},
            "images": [
              {
                "id": 123,
                "priority": 1,
                "image": "/path/image.jpg",
                "image_preview": "/path/preview.jpg",
                "lang": "ru"
              }
            ]
          }
        ],
        "page": 1,
        "totalPages": 1
      }
          

Метод позволяет получить данные конкретного события по уникальному id

Метод позволяет получить список билетов адреса

Запрос

Параметры

Пример ответа:

• • • 
      {
        "method": "tickets",
        "requestDate": 1760706127,
        "responseData": [
          {
            "id": 1,
            "userid": 100,
            "created": "2025-01-15 12:00:00",
            "last_updated": "2025-01-15 14:30:00",
            "status": 1,
            "time_from": "2025-01-20 19:00:00",
            "time_to": "2025-01-20 23:00:00",
            "name": "Иван Иванов",
            "phone": "79001234567",
            "email": "ivan@example.com",
            "text": "Комментарий к билету",
            "ticket_id": 1001,
            "event_id": 5,
            "event_name": "Живая музыка",
            "source": "widget",
            "time_open": null,
            "time_close": null,
            "time_cancel": null,
            "paymentPrice": 1500,
            "paymentTotal": 1500,
            "paymentRefund": 0,
            "paymentPaid": 1,
            "paymentOnline": 1,
            "paymentId": "pay_abc123",
            "info": {},
            "Parent_ID": 0,
            "Next_ID": 0,
            "getparams": {}
          }
        ],
        "page": 1,
        "totalPages": 1
      }
          

Метод позволяет получить данные конкретного билета по уникальному id