https://github.com/prathamesh017/e-commerce-api

https://github.com/prathamesh017/e-commerce-api

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/prathamesh017/e-commerce-api
• Owner: Prathamesh017
• Created: 2023-08-19T06:52:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-19T07:48:44.000Z (about 1 year ago)
• Last Synced: 2023-08-19T08:46:44.128Z (about 1 year ago)
• Language: TypeScript
• Size: 99.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
E-Commerce API DOCUMENATION

Welcome to the E-Commerce API documentation. This API allows you to see products ,add and remove them from cart and place order 

Hosted on Server URL 

```bash

https://e-commerce-api-bjp2.onrender.com/

```

Swagger 

```bash

https://e-commerce-api-bjp2.onrender.com/api/swagger

```

## Authentication

This API requires API key authentication. Include your API key in the Authorization header of your requests.

## ENDPOINTS

- AUTH 

 a) /auth/login  logins user  

 Method - Post. 

 Request - {  _

  email,       _

  password  _

  }

 Response  - Token (Use this for authentication)  

 

  b) /auth/register -  register user 

  Method - Post 

  Request - {

  name,

  email,

  password

  } 

  Response  - Token(Use this for authentication) 

 - Product 

   a) /product -  Get All Product 

   Method - Get  

   Response  - All Products

   

   b) /product/category -  Get All Category 

   Method - Get 

   Response  - All Category  

   

   c) /product/{id} -  Get A Product 

   Method - Get 

   Response  - A Product 

   

   d) /product -  Add a Product 

   Method - Post 

   Request- require admin token 

   Response  - Product 

  - Cart 

    a)/cart/view  see cart 

    Method - GET 

    Response - Cart  

    

    b)/cart/add  add item in cart 

    Method - POST 

    Request :{

    productID,

    quantity

    } 

    Response - Cart  

  

    c)/cart/remove  remove item in cart 

   Method - POST 

   Request :{

   productID

   } 

  Response - Cart  

 - ORDER 

   a)/order/history  see all order history 

   Method - GET 

   Response - order history 

 

   b)/order  add  order  

   Method - POST 

   Response - Order Added 

 

   c) /order/{id} -  Get Order Details 

   Method - Get 

   Response  - A Order Detail