Orders and Notifications Management

Our Order and Notification Management System, built with Java Spring Boot and adhering to RESTful API standards, design patterns, and SOLID principles, offers a suite of features designed to enhance the shopping and order management experience. Here's what you can expect:

Features

• Product Catalog: The system hosts a comprehensive product catalog that includes detailed information such as serial number, name, category, vendor, price, and current stock levels.

• Inventory Management: Provides capabilities for users to access a full list of products or details about specific items. It includes functionalities for adding new products to the inventory and updating existing items, ensuring that stock levels are maintained accurately.

• Dynamic User Interaction: The platform supports user functionalities including account registration and login. It also allows users to set and customize their notification preferences, choosing how they receive updates such as via email or SMS.

• Sophisticated Order Processing: The system facilitates the creation of new orders, addition of products to existing orders, and even the combination of multiple orders into a single transaction. It provides detailed tracking of each order's progress and offers flexible management options such as the ability to cancel order placements or shipping.

• Real-Time Analytics: Stakeholders have access to real-time analytics that deliver insights into the system’s performance, including data on users, products, and orders.

• Notification System: The system is equipped with a comprehensive notification mechanism that sends timely updates concerning the status of orders, including confirmations, payment receipts, and notifications of shipment.

---

Installation

To install and run this module, it's recommended to have the following prerequisites:

• Java 11 or higher
• Maven 3.6 or higher
• Postman or any other API testing tool

You also need to clone the GitHub repository and configure the application properties file with your database credentials and other settings.

• Clone the repo

  git clone https://github.com/KarimH537/OrdersNotificationsManagement.git

• Change directory

  cd OrdersNotificationsManagement\orders

• Build the project

  mvn clean install

• Run the application

  mvn spring-boot:run

---

Usage

To use this module, you need to test the API endpoints with Postman or any other tool. The module exposes the following API endpoints, grouped by category:

Inventory

• /inventory/getall: This endpoint returns a list of all products available for purchase, with serial number, name, category, sub-category, price, and remaining items count. It accepts a GET request with no parameters.

• /inventory/get/{serialNo}: This endpoint returns the information of a specific product, such as name, category, serial number, vendor, price, and the quantity. It accepts a GET request with a path variable containing the serial number of the product. For example:

  GET /inventory/get/P001

• /inventory/add: This endpoint allows adding a new product to the inventory, with name, category, sub-category, price, and items count. It accepts a POST request with a JSON body containing the product details. For example:

  {
    "serialNumber":"1",
    "name": "Camera",
    "vendor": "Cannon",
    "category": "Electronics",
    "price": 300,
    "quantity": 5
  }

• /inventory/increase: This endpoint allows increasing the quantity of an existing item in the inventory. It accepts a PUT request with a JSON body containing the item's serial number and the quantity to be added. For example:

  {
    "serialNumber":"1",
    "quantity": 5
  }

• /inventory/getcategories: This endpoint allows retrieving all the categories of items in the inventory. It accepts a GET request and does not require any parameters or a request body. For example, a simple GET request to this endpoint could look like this:

  GET /inventory/getcategories
  

User

• /user/register: This endpoint allows creating a new user account, with name, password, and balance. It accepts a POST request with a JSON body containing the user details. For example:

  {
    "name": "John Doe",
    "password": "123456",
    "balance": 1000
  }

• /user/login: This endpoint allows an existing user to log in to their account. It accepts a POST request with a JSON body containing the user’s name and password. For example:

  {
    "name": "John Doe",
    "password": "123456"
  }

• /user/setchannels/{username}: This endpoint allows selecting the channels to receive the notifications, such as email, or SMS. It accepts a PUT request with a JSON body containing the user prefrences. For example:

• {
  "email":true,
  "sms":true
  }

Order

• /order/create: This endpoint allows creating a new order, with the username and address.

  {
  "username":"John Doe",
  "address":"123 Main St"
  }

• /order/addproduct: This endpoint allows adding a product to an existing order. It accepts a POST request with a JSON body containing the order ID, the serial number, and the quantity. For example:

  {
    "id":1,
    "serialNumber":"1",
    "quantity":2
  }

• /order/addorder: This endpoint allows adding an order to another order, creating a compound order. It accepts a POST request with a JSON body containing the parent order ID and the child order ID. For example:

• {
    "parentOrderId": "0001",
    "childOrderId": "0002"
  }

• /order/get/{id}: This endpoint returns the details of an order, such as the products, the recipients, the fees, and the status. It accepts a GET request with a path variable containing the order ID. For example:

  GET /order/get/0001
  

• /order/cancelplacement: This endpoint allows canceling the placement of an order, before it is shipped. It accepts a PUT request with a JSON body containing the order ID.

• /order/cancelshipping: This endpoint allows canceling the shipping of an order, after it is shipped but before it is delivered. It accepts a PUT request with a JSON body containing the order ID.

• /order/place: This endpoint allows placing an order, confirming the payment and the shipping. It accepts a PUT request with a JSON body containing the order ID.

• /order/ship: This endpoint allows shipping an order, updating the status and sending a notification. It accepts a PUT request with a JSON body containing the order ID.

  For example:

  {
    "orderId": "0001"
  }

Info

• /inventory/getstats: This endpoint returns the statistics of the module, such as the number of users, products, orders, notifications, etc. It accepts a GET request with no parameters.

---

Contributors

• Abdelrhman Gamal
• Hazem Waheed
• Karim Hassib
• Mohamed Rady