BeeOrder API (1.0)

Download OpenAPI specification:Download

BeeOrder API

Authentication

BeeOrder offers one forms of authentication:

  • API Key

api-key

For this sample, you can use the api key special-key to test the authorization filters.

Security Scheme Type: API Key
Header parameter name: api-key

Restaurant

Everything about your Restaurant

Restaurants request

Get a list of all restaurants

Authorizations:
api-key
query Parameters
page
integer
Default: 1

Page number to retrieve

pageSize
integer
Default: 10

Number of restaurants to retrieve per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalPages": 20,
  • "currentPage": 1
}

Restaurant request

Get a specific restaurant by ID

Authorizations:
api-key
path Parameters
id
required
integer

ID of the restaurant

Responses

Response samples

Content type
application/json
{
  • "id": 5,
  • "name": {
    },
  • "description": {
    },
  • "logo": "string",
  • "coverImage": "string",
  • "tax": 5.5,
  • "commission": 0.14,
  • "status": "OPENED",
  • "address": {
    },
  • "phones": [
    ],
  • "queue": 10,
  • "orderSettings": {
    },
  • "deliverySettings": {
    },
  • "workingDays": [
    ],
  • "categories": {
    },
  • "DishOptions": [
    ],
  • "DishToppings": [
    ],
  • "menu": [
    ]
}

Notify clients of updates

Notify clients of updates to restaurant information, menu or menu items.

Request Body schema: application/json
Array
type
string
Enum: "RESTAURANT_BASIC_INFORMATION_UPDATED" "RESTAURANT_STATUS_UPDATED" "DISH_ADDED" "DISH_DELETED" "DISH_STATUS_UPDATED" "DISH_INFORMATION_UPDATED (including dish price)" "MENU_ADDED" "MENU_DELETED" "MENU_STATUS_UPDATED" "MENU_INFORMATION_UPDATED"

The type of update (e.g. menu item, restaurant basic information, etc.).

entity_id
string

The ID of the menu dish that was updated (if type is DISH).

entity_type
string
Enum: "RESTAURANT" "MENU" "DISH"

The type of entity that was updated.

data
Array of arrays

The updated properties | (eg. if the restaurant is updated then this should be an array of the updated properties, if the restaurant is deleted, then this should be an empty array).

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string"
}

Menu

Everything about your Restaurant's Menu

Restaurant's menu request

Get a menu for a specific restaurant by ID

Authorizations:
api-key
path Parameters
id
required
integer

ID of the restaurant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Provider Restaurant

Restaurants request

Get a list of all restaurants for a specific provider

Authorizations:
api-key
query Parameters
page
integer
Default: 1

Page number to retrieve

pageSize
integer
Default: 10

Number of restaurants to retrieve per page

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalPages": 20,
  • "currentPage": 1
}

Restaurant request

Get a specific restaurant by ID for a specific provider

Authorizations:
api-key
path Parameters
id
required
integer >= 1

ID of the restaurant

Responses

Response samples

Content type
application/json
{
  • "id": 5,
  • "name": {
    },
  • "description": {
    },
  • "logo": "string",
  • "coverImage": "string",
  • "tax": 5.5,
  • "commission": 0.14,
  • "status": "OPENED",
  • "address": {
    },
  • "phones": [
    ],
  • "queue": 10,
  • "orderSettings": {
    },
  • "deliverySettings": {
    },
  • "workingDays": [
    ],
  • "categories": {
    },
  • "DishOptions": [
    ],
  • "DishToppings": [
    ],
  • "menu": [
    ]
}

Restaurant's menu request

Get a menu for a specific restaurant by ID and specific provider

Authorizations:
api-key
path Parameters
id
required
integer >= 1

ID of the restaurant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bill

Retrieve a bill by ID

Authorizations:
api-key
path Parameters
id
required
integer >= 1

The ID of the bill to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "restaurantId": 0,
  • "subTotal": 0,
  • "tax": 0,
  • "orderType": "LATER_ORDER",
  • "total": 0,
  • "stauts": "CONFIRMED",
  • "expectedDriverArrivalTime": "2019-08-24T14:15:22Z",
  • "items": [
    ]
}