🍴Create your restaurant

APIs for managing properties with OctoTable API

ℹ️ A restaurant is an entity that represents a dining establishment, serving as a container for rooms, tables, or other components. It allows customers to book within a specific venue, enabling management of bookings across multiple areas or locations.

⚙️ Use the base resource URL for the following examples, or see complete collection

🔍 Find all restaurants

GET /properties

Get the list of properties see more

Headers

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

Response

200 OK

{
    "data": [
        {
            "enabled": false,
            "id": 999650,
            "name": "My Company SPA",
            "position": {},
            "sandbox": true
        },
        {
            "enabled": true,
            "id": 999651,
            "name": "My Property Name",
            "position": {},
            "sandbox": true
        }
    ]
} 

🔍 Find a restaurant

GET /properties/{id}

Find property by id see more

Headers

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

Response

200 OK

{
    "data": [
        {
            "id": 999642,
            "enabled": true,
            "name": "My Property Name",
            "position": {
                "latitude": 0,
                "longitude": 0
            },
            "sandbox": true,
            "subscription": {
                "license_version": {
                    "code": "EVO",
                    "default_price": 0,
                    "id": 2
                }
            }
        }
    ]
}

🆕 Create a new restaurant

POST /properties

Create new property see more

Headers

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

Body

Name	Type	Description
name	string	Name of the sandbox property
email	string	The email of the property
username	string	Username
password	string	Password
website	string	The website of the property
phone	string	The phone of the property
description	string	A brief description of the property

Response

201 Created

{
    "data": [
        {
            "id": 999642,
            "enabled": true,
            "name": "My Property Name",
            "position": {
                "latitude": 0,
                "longitude": 0
            },
            "sandbox": true,
            "subscription": {
                "license_version": {
                    "code": "EVO",
                    "default_price": 0,
                    "id": 2
                }
            }
        }
    ]
}

🔄 Update a restaurant

PUT /properties/{id}

Update the property see more

Headers

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

Body

Name	Type	Description
name	string	Name of the sandbox property
email	string	The email of the property
username	string	Username
password	string	Password
website	string	The website of the property
phone	string	The phone of the property
description	string	A brief description of the property

Response

200 OK

{
    "data": [
        {
            "id": 999642,
            "enabled": true,
            "name": "My Property Name",
            "position": {
                "latitude": 0,
                "longitude": 0
            },
            "sandbox": true,
            "subscription": {
                "license_version": {
                    "code": "EVO",
                    "default_price": 0,
                    "id": 2
                }
            }
        }
    ]
}

🗑️ Delete a property

DELETE /properties/{id}

Delete property by id see more

Headers

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

Response

200 OK

{
    "data": [
        999650
    ]
}