Shopease API

0. Table of Contents

1. Overview
2. Main Features
3. Schemas and Routes
4. Deployed Link

1. Overview

A RESTful API for an ecommerce platform to manage authentication, users, cart, wishlist, addresses, products, categories, brands, coupons, orders and reviews. It is built with Express.js and uses MongoDB as a database.

2. Main Features

• User authentication via JSON Web Tokens
• Database modelling using various Mongoose schemas
• Centralized error handling using Express middlewares
• Validation of request payload using Joi
• Routing using Express middlewares
• Logging of HTTP requests using Morgan
• Ability to parse multipart/form-data using Formidable
• Upload and delete images using Cloudinary APIs
• Ability to send emails using Nodemailer
• Integration of Razorpay payment gateway
• Verification of email addresses and phone numbers using Abstract APIs (third party service)
• Scheduled cron jobs to check the expiry status of coupons
• Configured pm2 to keep API and cron jobs running as daemon processes
• API and Cron jobs are hosted on DigitalOcean droplet using Nginx as a web server

3. Schemas and Routes

Shopease API consists of 8 schemas and 70+ routes and controllers.

Authentication Routes

• Signup -> POST /auth/signup
• Login -> POST /auth/login
• Logout -> POST /auth/logout
• Forgot password -> POST /auth/password/forgot
• Reset password -> PUT /auth/password/reset/:token

User Routes

• Fetch profile -> GET /users/self
• Update profile -> PUT /users/self
• Delete account -> DELETE /users/self
• Add profile photo -> POST /users/self/avatar
• Remove profile photo -> PUT /users/self/avatar
• Update profile photo -> POST /users/self/avatar/update
• Fetch users -> GET /admin/users
• Fetch user by ID -> GET /admin/users/:userId
• Update user role -> PUT /admin/users/:userId
• Delete user -> DELETE /admin/users/:userId
• Fetch other admins -> GET /admin/admins
• Admin self demote -> PUT /admin/self
• Admin self delete -> DELETE /admin/self

Address Routes

• Fetch addresses -> GET /addresses
• Add new address -> POST /addresses
• Fetch address by ID -> GET /addresses/:addressId
• Update address -> PUT /addresses/:addressId
• Delete address -> DELETE /addresses/:addressId
• Set default address -> PUT /addresses/:addressId/default

Cart Routes

• Fetch cart -> GET /cart
• Add item to cart -> POST /cart/add
• Remove item from cart -> PUT /cart/remove
• Update item quantity -> PUT /cart/update
• Move item to wishlist -> PUT /cart/move
• Clear cart -> PUT /cart/clear

Wishlist Routes

• Fetch wishlist -> GET /wishlist
• Add item to wishlist -> PUT /wishlist/add
• Remove item from wishlist -> PUT /wishlist/remove
• Move item to cart -> PUT /wishlist/move
• Clear wishlist -> PUT /wishlist/clear

Product Routes

• Fetch products -> GET /products
• Fetch product by ID -> GET /products/:productId
• Admin fetch products -> GET /admin/products
• Add new product -> POST /admin/products
• Admin fetch product by ID -> GET /admin/products/:productId
• Update product details -> POST /admin/products/:productId
• Delete product -> DELETE /admin/products/:productId
• Restore deleted product -> PUT /admin/products/:productId/restore

Category Routes

• Fetch all categories -> GET /categories
• Fetch category by ID -> GET /categories/:categoryId
• Add new category -> POST /admin/categories
• Update category -> POST /admin/categories/:categoryId
• Fetch product categories -> GET /product/categories

Brand Routes

• Fetch all brands -> GET /brands
• Fetch brand by ID -> GET /brands/:brandId
• Add new brand -> POST /admin/brands
• Update brand -> POST /admin/brands/:brandId
• Fetch product brands -> GET /product/brands

Coupon Routes

• Fetch valid coupons -> GET /coupons
• Check coupon validity -> GET /coupons/validity
• Admin fetch coupons -> GET /admin/coupons
• Create new coupon -> POST /admin/coupons
• Fetch coupon by ID -> GET /admin/coupons/:couponId
• Update coupon details -> PUT /admin/coupons/:couponId
• Delete coupon -> DELETE /admin/coupons/:couponId
• Change coupon state -> PUT /admin/coupons/:couponId/state

Order Routes

• Fetch orders -> GET /orders
• Create new order -> POST /orders
• Fetch order by ID -> GET /orders/:orderId
• Confirm order -> PUT /orders/:orderId/confirm
• Cancel order -> PUT /orders/:orderId/cancel
• Admin fetch orders -> GET /admin/orders
• Admin fetch order by ID -> GET /admin/orders/:orderId
• Update order status -> PUT /admin/orders/:orderId
• Delete order -> DELETE /admin/orders/:orderId

Product Review Routes

• Fetch product reviews -> GET /products/:productId/reviews
• Add product review -> POST /products/:productId/reviews
• Fetch review by ID -> GET /reviews/:reviewId
• Update product review -> PUT /reviews/:reviewId

4. Deployed Link

This project is hosted on this domain - click here.