DineMe
API Reference
Docs OpenAPI Swagger

Restaurant POS System

Build modern restaurant workflows with a clean, predictable API surface. This page is generated from /openapi.json.

Base URL: / Auth: Bearer JWT OpenAPI 3.1.0 Version: 1.0.0
Quick start
curl -X POST /login \
  -H "Content-Type: application/json" \
  -d '{"username":"manager","password":"manager123"}'

Use the access token in Authorization header.

Endpoints

Search by path, tag, or summary
/

Rooms

7 endpoints
GET /rooms
Get Rooms
Get all rooms for the current user's restaurant.
Responses
200 Response Get Rooms Rooms Get
Successful Response
POST /rooms
Create Room
Create a new room.
Request Body
application/json
RoomCreate
Responses
200 RoomResponse
Successful Response
422 HTTPValidationError
Validation Error
GET /rooms/allocations
Get All Allocations
Get all room allocations for the restaurant.
Responses
200 Response Get All Allocations Rooms Allocations Get
Successful Response
PUT /rooms/{room_id}
Update Room
Update a room's details.
Parameters
room_id (path)
string:uuid
required
Request Body
application/json
RoomUpdate
Responses
200 RoomResponse
Successful Response
422 HTTPValidationError
Validation Error
DELETE /rooms/{room_id}
Delete Room
Delete a room. Only allowed if there are no active allocations.
Parameters
room_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
POST /rooms/{room_id}/allocate
Allocate Room
Allocate a room to a customer.
Parameters
room_id (path)
string:uuid
required
Request Body
application/json
RoomAllocationCreate
Responses
200 RoomAllocationResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /rooms/{room_id}/checkout
Checkout Room
Check out a customer from a room and calculate bill.
Parameters
room_id (path)
string:uuid
required
Responses
200 RoomAllocationResponse
Successful Response
422 HTTPValidationError
Validation Error

admin

3 endpoints
GET /admin/restaurants
Get Pending Restaurants
Get all restaurants (pending and approved) for super admin
Responses
200 Response Get Pending Restaurants Admin Restaurants Get
Successful Response
POST /admin/restaurants/{restaurant_id}/approve
Approve Restaurant
Approve a restaurant
Parameters
restaurant_id (path)
string:uuid
required
Responses
200 RestaurantResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /admin/restaurants/{restaurant_id}/reject
Reject Restaurant
Reject/delete a restaurant
Parameters
restaurant_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error

analytics

6 endpoints
GET /analytics/order-status
Get Order Status Distribution
Get order status distribution
Responses
200 object
Successful Response
GET /analytics/overview
Get Analytics Overview
Get overview analytics for the restaurant
Responses
200 object
Successful Response
GET /analytics/peak-hours
Get Peak Hours
Get order distribution by hour of day (12-hour format)
Responses
200 object
Successful Response
GET /analytics/revenue-by-category
Get Revenue By Category
Get revenue breakdown by menu category
Responses
200 object
Successful Response
GET /analytics/revenue-trend
Get Revenue Trend
Get revenue trend for the last N days
Parameters
days (query)
integer
optional
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
GET /analytics/top-items
Get Top Items
Get top selling menu items
Parameters
limit (query)
integer
optional
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error

auth

3 endpoints
POST /login
Login
Request Body
application/json
LoginRequest
Responses
200 Token
Successful Response
422 HTTPValidationError
Validation Error
POST /refresh
Refresh Token
Refresh access token using refresh token
Request Body
application/json
RefreshTokenRequest
Responses
200 Token
Successful Response
422 HTTPValidationError
Validation Error
POST /register
Register Restaurant
Register a new restaurant and create a manager account
Request Body
application/json
RestaurantCreate
Responses
200 RestaurantResponse
Successful Response
422 HTTPValidationError
Validation Error

bills

5 endpoints
GET /bills
Get All Bills
Responses
200 Response Get All Bills Bills Get
Successful Response
GET /bills/{bill_id}
Get Bill
Parameters
bill_id (path)
string:uuid
required
Responses
200 BillResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /bills/{bill_id}/approve
Approve Bill
Parameters
bill_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
GET /bills/{bill_id}/detailed
Get Detailed Bill
Get detailed bill information with restaurant details and order items for printing
Parameters
bill_id (path)
string:uuid
required
Responses
200 DetailedBillResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /bills/{order_id}
Create Bill
Parameters
order_id (path)
string:uuid
required
Responses
200 BillResponse
Successful Response
422 HTTPValidationError
Validation Error

categories

4 endpoints
GET /categories
Get Categories
Responses
200 Response Get Categories Categories Get
Successful Response
POST /categories
Create Category
Request Body
application/json
CategoryCreate
Responses
200 CategoryResponse
Successful Response
422 HTTPValidationError
Validation Error
PUT /categories/{category_id}
Update Category
Parameters
category_id (path)
string:uuid
required
Request Body
application/json
CategoryUpdate
Responses
200 CategoryResponse
Successful Response
422 HTTPValidationError
Validation Error
DELETE /categories/{category_id}
Delete Category
Parameters
category_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error

health

1 endpoints
GET /health
Health Check
Responses
200 object
Successful Response

menu-items

5 endpoints
GET /menu-items
Get Menu Items
Get all menu items (including unavailable) for the current user's restaurant
Responses
200 Response Get Menu Items Menu Items Get
Successful Response
POST /menu-items
Create Menu Item
Request Body
multipart/form-data
Body_create_menu_item_menu_items_post
Responses
200 MenuItemResponse
Successful Response
422 HTTPValidationError
Validation Error
GET /menu-items/all
Get All Menu Items
Responses
200 Response Get All Menu Items Menu Items All Get
Successful Response
PUT /menu-items/{item_id}
Update Menu Item
Parameters
item_id (path)
string:uuid
required
Request Body
multipart/form-data
Body_update_menu_item_menu_items__item_id__put
Responses
200 MenuItemResponse
Successful Response
422 HTTPValidationError
Validation Error
DELETE /menu-items/{item_id}
Delete Menu Item
Parameters
item_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error

orders

10 endpoints
GET /orders
Get All Orders
Responses
200 Response Get All Orders Orders Get
Successful Response
GET /orders/chef
Get Chef Orders
Get all pending and in-progress orders for the chef in their restaurant
Responses
200 Response Get Chef Orders Orders Chef Get
Successful Response
POST /orders/table/{table_id}
Create Order
Parameters
table_id (path)
string:uuid
required
Request Body
application/json
CreateOrderRequest
Responses
200 OrderResponse
Successful Response
422 HTTPValidationError
Validation Error
GET /orders/table/{table_id}
Get Table Order
Get the active order for a specific table
Parameters
table_id (path)
string:uuid
required
Responses
200 OrderResponse
Successful Response
422 HTTPValidationError
Validation Error
GET /orders/{order_id}
Get Order
Parameters
order_id (path)
string:uuid
required
Responses
200 OrderResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /orders/{order_id}/add-items
Add Items To Order
Parameters
order_id (path)
string:uuid
required
Request Body
application/json
CreateOrderRequest
Responses
200 OrderResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /orders/{order_id}/cancel-items
Cancel Order Items
Cancel/remove items from an order if it's not prepared or completed
Parameters
order_id (path)
string:uuid
required
Request Body
application/json
CancelOrderItemsRequest
Responses
200 OrderResponse
Successful Response
422 HTTPValidationError
Validation Error
POST /orders/{order_id}/complete
Complete Order
Complete an order, generate bill, and release the table
Parameters
order_id (path)
string:uuid
required
Request Body
application/json
CompleteOrderRequest
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
POST /orders/{order_id}/prepared
Mark Order Prepared
Parameters
order_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
PUT /orders/{order_id}/update
Update Order
Parameters
order_id (path)
string:uuid
required
Request Body
application/json
UpdateOrderRequest
Responses
200 OrderResponse
Successful Response
422 HTTPValidationError
Validation Error

restaurant

1 endpoints
GET /restaurant
Get Current Restaurant
Get current user's restaurant information
Responses
200 RestaurantResponse
Successful Response

settings

3 endpoints
GET /settings
Get Settings
Responses
200 SettingsResponse
Successful Response
POST /settings/gst
Update Gst
Request Body
application/json
UpdateGSTRequest
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
POST /settings/tips
Update Tips
Request Body
application/json
UpdateTipsRequest
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error

tables

6 endpoints
GET /tables
Get Tables
Get all tables in the current user's restaurant
Responses
200 Response Get Tables Tables Get
Successful Response
POST /tables
Create Table
Request Body
application/json
TableCreate
Responses
200 TableResponse
Successful Response
422 HTTPValidationError
Validation Error
PUT /tables/{table_id}
Update Table
Parameters
table_id (path)
string:uuid
required
Request Body
application/json
TableUpdate
Responses
200 TableResponse
Successful Response
422 HTTPValidationError
Validation Error
DELETE /tables/{table_id}
Delete Table
Parameters
table_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
POST /tables/{table_id}/assign_customer
Assign Customer
Parameters
table_id (path)
string:uuid
required
Request Body
application/json
AssignCustomerRequest
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error
POST /tables/{table_id}/release
Release Table
Parameters
table_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error

users

4 endpoints
GET /users
Get Users
Get all users in the current user's restaurant
Responses
200 Response Get Users Users Get
Successful Response
POST /users
Create User
Create a new user in the current user's restaurant
Request Body
application/json
UserCreate
Responses
200 UserResponse
Successful Response
422 HTTPValidationError
Validation Error
PUT /users/{user_id}
Update User
Update a user in the current user's restaurant
Parameters
user_id (path)
string:uuid
required
Request Body
application/json
UserUpdate
Responses
200 UserResponse
Successful Response
422 HTTPValidationError
Validation Error
DELETE /users/{user_id}
Delete User
Delete a user from the current user's restaurant
Parameters
user_id (path)
string:uuid
required
Responses
200 object
Successful Response
422 HTTPValidationError
Validation Error