OctoTable API
  • 👋Welcome to OctoTable's API documentation
  • Getting Started with the API Collection in Postman
  • Create Clients
    • 🆕How to create clients
  • Authentication
    • 🔑Create Token
  • Getting started with reservations
    • 🍴Create your restaurant
    • đŸŊī¸Manage your rooms
      • đŸĒ‘Manage your tables and booking components
      • 📅Manage your services
    • 📝Manage your reservations
      • đŸ—“ī¸Get booking!
      • â‰ī¸Where are my slots?
    • âš ī¸Error Manual
      • Overview
      • Error reasons
Powered by GitBook
On this page
  • 🔍 Find available slots
  • 🔍 Find available rooms
  • Create a new user
  1. Getting started with reservations
  2. Manage your reservations

Where are my slots?

APIs for managing booking slots and available rooms

PreviousGet booking!NextError Manual

Last updated 4 months ago

â„šī¸ You have to follow the strict order of actions to get available slots: create at least one room, create at least one table and at least one service. To verify if you already have it just use the GET method to retrieve available resources. Example: GET /rooms, GET /tables, GET /services.

âš™ī¸ Use the base resource URL for the following examples, or

https://api.octorate.com/octotable-pms/api/v2

🔍 Find available slots

GET /bookings/slots

Returns all time slots for this property from a start day and other filters

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Property

<your_property_id>

Query params

Name
Type
Description

start_date

date time

The start day of search

pax

int

The number of persons

service_id

int

The id of the selected service

Response

{
    "data": [
        {
            "day": "2024-11-19",
            "available_services": [
                {
                    "id": 30601,
                    "title": "Lunch",
                    "available_slots": [
                        "12:00:00",
                        "12:30:00",
                        "13:00:00",
                        "13:30:00",
                        "14:00:00"
                    ]
                },
                {
                    "id": 30602,
                    "title": "Dinner",
                    "available_slots": [
                        "19:00:00",
                        "19:30:00",
                        "20:00:00",
                        "20:30:00",
                        "21:00:00",
                        "21:30:00",
                        "22:00:00"
                    ]
                }
            ]
        }
    ]
}

🔍 Find available rooms

GET /bookings/rooms

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Property

<your_property_id>

Query params

Name
Type
Description

start_date

date [YYYY-MM-DD]

The start date of search

start_hour

time [HH:mm:ss]

The start time of search

pax

int

The number of persons

service_id

int

The id of the selected service

Response

{
    "data": [
        [
            {
                "id": 21344,
                "property_id": 999643,
                "name": "Secondary dining room",
                "bookable": true,
                "tables": [
                    {
                        "id": 172246,
                        "name": "T8",
                        "bookable": true,
                        "free": true,
                        "group": false,
                        "guests_max": 10,
                        "guests_min": 1,
                        "room_id": 21344
                    }
                ]
            }
        ]
    ]
}

Create a new user

GET /bookings/list

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Property

<your_property_id>

Response

{
    "data": [
        {
            "name": "BOOKING_ENGINE_PAGE",
            "link": "http://localhost:4200/restaurant/999652/booking/new"
        },
        {
            "name": "SERVICES_PAGE",
            "link": "http://localhost:4200/restaurant/999652/booking/home"
        },
        {
            "name": "WELCOME_PAGE",
            "link": "http://localhost:4200/restaurant/999652/welcome"
        }
    ]
}

Retrieves available rooms and tables for a certain service

Retrieves booking engine redirect links

📝
â‰ī¸
see the complete collection
see more
see more
see more