The Order Management System (OMS) API is a tool designed to facilitate order-taking for hotels using a touch screen device or any other system. Customers can conveniently visit the hotel, insert their details (with the name being compulsory), select the items they wish to buy, and place their orders. The API empowers the hotel staff with an efficient system to manage customer orders and act accordingly.
Note: This project is purely for practice purposes and serves as a proof of concept for an Order Management System. It is not intended for production use.
It supports the following functionalities:
- Register new customers with their contact details.
- List all available menu items for customers to choose from.
- Adding, updating, and deleting menu items.
- Placing customer orders with selected items and quantities.
- Retrieving orders based on their status (e.g., pending, complete, canceled).
- Updating the status of orders as they progress through the kitchen.
| Endpoint | Method | Description | Request Data Structure | Remark |
|---|---|---|---|---|
/admin/login |
POST | Authenticate administrator login. | { "username": "admin", "password": "admin" } |
Default username and password are "admin" and "admin." |
/admin/logout |
GET | Logout the currently logged-in administrator. | N/A | N/A |
/register |
POST | Register a new customer with their details. | { "id": "121", "name": "John Doe", "phone": "123-456-7890", "email": "[email protected]", "address": "123 Main St, City" } |
"name" and "id" are required, "id" is not auto given |
/item |
GET | Retrieve a list of all available menu items. | N/A | N/A |
/item/:id |
GET | Get details of a specific menu item by ID. | N/A | "id" should be a Number. |
/item/additem |
POST | Add a new menu item. | { "name": "Burger", "price": 10.99, image: "image file" } |
Both "name" and "price" are required. |
/item/updateitem/:id |
PATCH | Update an existing menu item by ID. | { "name": "New Burger Name", "price": 12.99, image: "image file" } |
N/A |
/item/delete/:id |
DELETE | Delete a menu item by ID. | N/A | N/A |
/order/add |
POST | Place a new order with selected items and quantities. | { "customerId": 121, "totalAmount": 500, "orderStatus": "pending", "orderItems": [ { "itemId": 1, "quantity": 2 }, { "itemId": 3, "quantity": 1 } ] } |
"status" should be one of: "pending," "complete," or "canceled." |
/order/get/:status |
GET | Retrieve orders based on their status. | N/A | "status" should be one of: "pending," "complete," or "canceled." |
/order/get/orderid/:orderId |
GET | Retrieve orders based on order ID. | N/A | N/A |
/order/changestatus |
PUT | Update the status of an order by ID. | { "id": "250", "status": "complete" } |
should use "order_id" generated while adding order |
To stay updated on new orders in real-time, you can listen for the "order" event using socket.io-client. This allows your client application to receive notifications whenever a new order is placed without having to constantly poll the server for updates.
To run this API locally or test it in your environment, follow the steps outlined:
- Clone the project to your local machine:
git clone https:/abishek0057/order-management.git - Open the terminal in the project root directory and install the required dependencies:
npm install - Start the server using the following command:
npm run dev - Now you are ready to make requests to the API endpoints. These steps will help you set up the API on your local machine for testing and development purposes. Feel free to explore and interact with the different endpoints using your preferred API testing tools.
Contributions to improve this proof of concept project are welcome! If you find any issues or have suggestions for enhancements, please feel free to submit a pull request.