🗓️Get booking!

APIs for managing reservations, including creating, updating, and canceling table bookings within the restaurant

ℹ️ The Booking Engine is the core feature, allowing customers to make reservations, choose rooms, slot times, number of persons and cancel existing bookings. ⚙️ Use the base resource URL for the following examples, or see the complete collection

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

🔍 Find all reservations

GET /reservations

Retrieves a list of all reservations for the specified property (e.g., restaurant) using the property ID see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Query params

Name	Type	Description
next_cursor	string	Pagination cursor
limit	int	Elements limit per page
start_date	date [YYYY-MM-DD]	Start day of search
end_date	date [YYYY-MM-DD]	End day of search
status[]	[WAITING, ACCEPTED, CANCELLED, CONFIRMED, EXPIRED, PREPAY, OUTOFORDER, REJECTED]	The status of reservation
text_search	string	The text search by customer name, last name or phone number
service_ids[]	[int]	The id list of services
room_ids[]	[int]	The id list of rooms

Response

200 OK

{
    "data": [
        {
            "id": 31753957,
            "pax": 2,
            "status": "WAITING",
            "customer": {
                "id": 33499558,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30911,
                "name": "Lunch"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21344,
                "name": "Secondary dining room"
            },
            "end_date": "2024-12-14T13:30:00",
            "start_date": "2024-12-14",
            "start_hour": "12:30:00",
            "tables": [
                {
                    "id": 172246,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21344
                }
            ],
            "waiting_list": false
        },
        {
            "id": 31753958,
            "pax": 2,
            "status": "CONFIRMED",
            "customer": {
                "id": 33499559,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30911,
                "name": "Lunch"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21344,
                "name": "Secondary dining room"
            },
            "end_date": "2024-12-14T14:30:00",
            "start_date": "2024-12-14",
            "start_hour": "13:30:00",
            "tables": [
                {
                    "id": 172246,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21344
                }
            ],
            "waiting_list": false
        }
    ],
    "next_cursor": "MzE3NTM5NTc6MjAyNC0xMi0xNDo="
}

🔍 Find a reservation

GET /reservations/{reservation_id}

Retrieves a reservations by its ID see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Response

200 OK

{
    "data": [
        {
            "id": 31753958,
            "pax": 2,
            "status": "CONFIRMED",
            "customer": {
                "id": 33499559,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30911,
                "name": "Lunch"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21344,
                "name": "Secondary dining room"
            },
            "end_date": "2024-12-14T14:30:00",
            "start_date": "2024-12-14",
            "start_hour": "13:30:00",
            "tables": [
                {
                    "id": 172246,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21344
                }
            ],
            "waiting_list": false
        }
    ]
}

🆕 Create a new reservation

POST /reservations

Creates a new reservation for the specified property using the provided reservation details see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Body

Name	Type	Description
start_date	date [YYYY-MM-DD]	The start date
start_hour	time [HH:mm:ss]	The start hour
pax	int	The number of person
channel	enum [OCTOTABLE_BOOK, OCTOTABLE_ADMIN]	OCTOTABLE_BOOK: This indicates reservations made through the Booking Engine. resents reservations made through Reserve with Google. OCTOTABLE_ADMIN: Refers to self reservations.
customer	Customer	The customer who makes the reservation
customer.first_name	string	The customers first name
customer.last_name	string	The customer last name
customer.email	string	The customers email
customer.phone	string	The customers phone
service_id	int	The id of the selected service
room_id	int	The id of the selected room
table_ids	[int]	The list of ids of the selected tables
waiting_list	boolean	Keep reservation in waiting list

Response

201 Created

{
    "data": [
        {
            "id": 31753958,
            "pax": 2,
            "status": "CONFIRMED",
            "customer": {
                "id": 33499559,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30911,
                "name": "Lunch"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21344,
                "name": "Secondary dining room"
            },
            "end_date": "2024-12-14T14:30:00",
            "start_date": "2024-12-14",
            "start_hour": "13:30:00",
            "tables": [
                {
                    "id": 172246,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21344
                }
            ],
            "waiting_list": false
        }
    ]
}

🟢 Enable Google Engine

POST /reservations/google

Activates the Google Engine for a specified property see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Body

Name	Type	Description
enable_google_engine	boolean	Enable the google engine

Response

200 OK

{
  "status": "ACCEPTED"
}

🔄 Update a reservation

PUT /reservations/{reservation_id}

Update an existing reservation see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Body

Name	Type	Description
start_date	date [YYYY-MM-DD ]	The start day
start_hour	time [HH:mm:ss]	The start hour
pax	int	The number of person
service_id	int	The id of the selected service
room_id	int	The id of the selected room
table_ids	[int]	The list of ids of the selected tables

Response

200 OK

{
    "data": [
        {
            "id": 31753936,
            "pax": 2,
            "status": "CONFIRMED",
            "customer": {
                "id": 3255826,
                "first_name": "John",
                "last_name": "Smith",
                "email": "[e-mail]",
                "phone": "55555555555"
            },
            "service": {
                "id": 17884,
                "name": "Breakfast"
            },
            "channel": "OCTOTABLE_BOOK",
            "end_date": "2024-10-30T20:00:00",
            "start_date": "2024-10-30T18:00:00",
            "start_day": "2024-10-30",
            "start_hour": "18:00:00"
        }
    ]
}

🔄 Check in

PATCH /reservations/{reservation_id}/checkin

Customers check-in see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Query params

Name	Type	Description
undo	boolean	Undo check in if it has been made by mistake

Response

200 OK

{
    "data": [
        {
            "id": 31753956,
            "pax": 2,
            "status": "ACCEPTED",
            "customer": {
                "id": 33499557,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30907,
                "name": "Pranzo nuovo"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21343,
                "name": "main dining room"
            },
            "checkin_date": "2024-12-12T17:04:04.564",
            "end_date": "2024-12-12T13:30:00",
            "expiration_date": "2024-12-12T17:13:49",
            "start_date": "2024-12-12",
            "start_hour": "12:30:00",
            "tables": [
                {
                    "id": 172245,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21343
                }
            ],
            "waiting_list": false
        }
    ]
}

🔄 Check out

PATCH /reservations/{reservation_id}/checkout

Customers check out see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Query param

Name	Type	Description
undo	boolean	Undo check out if it has been made by mistake

Response

200 OK

{
    "data": [
        {
            "id": 31753958,
            "pax": 2,
            "status": "CONFIRMED",
            "customer": {
                "id": 33499559,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30911,
                "name": "Lunch"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21344,
                "name": "Secondary dining room"
            },
            "end_date": "2024-12-14T14:30:00",
            "start_date": "2024-12-14",
            "start_hour": "13:30:00",
            "tables": [
                {
                    "id": 172246,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21344
                }
            ],
            "waiting_list": false
        }
    ]
}

🔄 Update status

PATCH /reservations/{reservation_id}

Update the status of the reservation in waiting list. If on the waiting list, the reservation should become accepted, declined, or confirmed see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Query param

Name	Type	Description
status	enum	The status of the reservation in waiting list

Response

200 OK

{
    "data": [
        {
            "id": 31753956,
            "pax": 2,
            "status": "WAITING",
            "customer": {
                "id": 33499557,
                "first_name": "Adam",
                "last_name": "Devis",
                "email": "[e-mail]",
                "phone": "3332211456"
            },
            "service": {
                "id": 30907,
                "name": "Pranzo nuovo"
            },
            "channel": "OCTOTABLE_ADMIN",
            "room": {
                "id": 21343,
                "name": "main dining room"
            },
            "end_date": "2024-12-12T13:30:00",
            "start_date": "2024-12-12",
            "start_hour": "12:30:00",
            "tables": [
                {
                    "id": 172245,
                    "name": "T8",
                    "bookable": true,
                    "free": true,
                    "group": false,
                    "room_id": 21343
                }
            ],
            "waiting_list": false
        }
    ]
}

🗑️ Delete a reservation

DELETE /reservations/{reservation_id}

Delete a reservation see more

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Property	<your_property_id>

Response

200 OK

{
    "data": [
        172221
    ]
}