Git Product home page Git Product logo

orders-and-notifications-management's Introduction

Orders and Notifications Management API

Overview

This project focuses on creating "Orders and Notifications Management" module for e-commerce system. The system provides essential features, including product listing, customer account management, order placement, shipping, and notification handling.

Features

  1. Store Products Listing
  2. Customer Account Management
  3. Order Placement
  4. Order Cancellation
  5. Order Details
  6. Notifications Handling

API Endpoints

  1. Create Account
  2. View Catalog
  3. Make simple order
  4. Make compound order
  5. Show Customer Notifications
  6. Cancel Order
  7. Cancel order shipping
  8. View the remaining products of a category
  9. Get the most notified phone number
  10. Get the most used template

UML System Class Diagram

UML Class Diagram

Endpoints:

Exposed API Description Input
POST /createAccount Creates a new account for that customer adds it to customer repo, and returns confirmation message Account object
GET /product/list Returns all the products that are currently in stock NONE
GET /product/{categoryName} A count of the remaining parts from each category should be available. NONE
DELETE /product/remove/{serialNumber} remove product from the repo NONE
POST /product/add create product and add it to the repo product object
POST /order/placeSimpleOrder Create a new simple order add it to the orders repo complete payment and send a notification to the customer Simple Order object
POST /order/placeCompoundOrder{email} Create a new compound order add it to the orders repo complete payment for each customer and send a notification to each customer Compound Order object
GET /order/listOrders List all details of the order whether it's simple or compound NONE
DELETE /order/cancelOrder/{id} Check if the order can be canceled if it is it changes its status to canceled and return the money to the customers and return the products to the products repo NONE
DELETE /order/cancelOrderShipping/{id} Check if the order can be canceled if it is it changes its status to canceled it's shipping and returns the money to the customers NONE
GET /mostUsedTemplate Returns a string with the templates' statistics, sorted by their frequencies, representing the number of times each template has been sent. NONE
GET /mostNotified Returns a string that has the statistics for the most notified email addresses and phone numbers NONE
GET /notifications Returns a the current notifications in the queue NONE

Contributors

orders-and-notifications-management's People

Contributors

ayaa1i avatar mayazayn avatar saratamer avatar basmalahgad avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.