Untitled Document

API Documentation
Version Date Author Description
1.0 26-11-2022 RAMEESUL YOONUS MTP Initial draft
1. MASTER ADMIN:
1. Master admin Login:

Master admin have a username and password
Method URL
POST Master_admin_login
Request
Parameter Name Description Type & Length
User Name Master Admin have a username String
Password Master Admin have a password Password
Response
200 “Successfully Login to Master Admin pane

”
501 {“error”:”Username and password invalid}

2. Master Admin Panel:
This is the page for the Master admin to view and edit the data of the
website.
Method URL
GET master_admin_panel
Response
200 ’Success’. Enter to

master_admin_Panel
BRANDS
Here Master admin can manage Brands and their products
Method URL
GET admin_panel/brands
Response
Parameter Name Description
200 OK
1. Add Brands
Here Master admin can add a brand’s account.
Method URL
GET admin_panel/products/add_brand
Request
Brand name Name of the brand String
Reg number Registration no of outlet int
GST no GST number of the outlet int
Email Email of the outlet email
Password Password for the account password
Response
200 ’Success’.
2. Edit Brands
Here Master Admin can edit Brands.
Method URL
PUT admin_panel/brands/edit_brands/id
Request
Response
200 ’Success’.
3. Delete Brands
Here Master admin can delete or block brands.
Method URL
DELETE admin_panel/brands/delete_brands/id
Response
200 OK
USERS
Master admin can view and manage user information.
1. View Users
Admin can view all details about the user.
Method URL
GET admin_panel/user_management
Response
Email Email of the user String
Username User name of the user String
No of orders Number of orders of the user int
Complaints Complaints posted by the user String
2. Edit Users
Admin can edit details about the user..

Method URL
PUT admin_panel/user_management/edit_user/user_id
Request
Name Name of the user String
Username User name of the user string
Mobile number Mobile number of the user int
Email User email email
Password Password of the user password
Order details Details of orders done by user Stringj
Response
200 ’Success’.
3. Delete Users
Admin can delete or Block users .
Method URL
DELETE admin_panel/user_management/delete_user/user_id
Response
200 OK
2. ADMIN:
1. Admin Sign Up:
Here Admin can register details and create login .

Method URL
POST /admin_registration
Request
1. Admin Login:
Admin have a username and password
Method URL
POST admin_login
Request
User Name Admin have a username String
Password Admin have a password Password
Response
200 “Successfully Login to Admin panel ”
501 {“error”:”Username and password invalid}
2. Admin Panel:
This is the page for the Admin to view and edit the data of the
website.
Method URL
GET admin_panel
Response
200 ’Success’. Enter to admin_Panel
PRODUCTS
Here Admin can manage Products
Method URL
GET admin_panel/products
Response
200 OK
1. Add Products
Here Admin can add products.
Method URL
GET admin_panel/products/add_product
Request
Category Category of the product Strin

Product color Color of the product String
Product pattern Pattern type of the product String
Gender Gender of the product String
Price Price of the product int
Sizes Available sizes of product String
Quantity Quantity of the product int
Product Image Image of the product image
Response
200 ’Success’.
2. Edit Products
Here Admin can add products.
Method URL
PUT admin_panel/products/edit_products/id
Request
Category Category of the product String

Product name Name of the product string
Product color Color of the product String
Product pattern Pattern type of the product String
Gender Gender of the product String
Price Price of the product int
Sizes Available sizes of product String
Quantity Quantity of the product int
Product Image Image of the product image
Response
200 ’Success’.
3. Delete Products
Here Admin can delete products.
Method URL
DELETE admin_panel/products/delete_products/id
Response
200 OK
ORDERS
Here Admin can manage Products
Method URL
GET admin_panel/orders
Response
200 OK
1. View Orders
Admin can edit and update orders.
Method URL
PUT admin_panel/orders/edit_orders/order_id
Request
Order id Id or the order String
username Username of the user string
Address Address of the user String
Products info Info of the products ordered String

Order price Total price of Order int
Order status Current status of the order string
Date and time Date and time of the order Date and time
price Price of the product int
2. Edit Orders
Admin can edit and update orders.
Method URL
PUT admin_panel/orders/edit_orders/order_id
Request
Order id Id or the order String
username Username of the user string
Address Address of the user String
Products info Info of the products ordered String
Order price Total price of Order int
Order status Current status of the order string
Date and time Date and time of the order Date and time
price Price of the product int

Response
200 ’Success’.
3. Delete Orders
Admin can delete the orders.
Method URL
DELETE admin_panel/products/delete_orders/orders_id
Response
200 OK
ADMIN LOGOUT:
Admin can logout from the admin panel..
Method URL
GET admin_logout
Response
200 OK
3.LANDING PAGE:
1. Loading Lead Page:

Here users can view loading page
Method URL
GET http://127.0.0.1:8000/
Response
200 OK
2. User:
1. User Sign Up:
Here User can register details and create login .

Method URL
POST /user_registration
Request
Phone No. User phone number int
Password User can add password password
Response
200 ’Success’.
2. User Login:
Here users can sign in with registered username and password.
Method URL
POST /user_signin
Request
Username User have a username string
Password User have a password password
Response
200 ’Success’.
3. Add Cart:
Here User can add products to the cart
Method URL
GET add_cart
Response
200 OK
4. View :
users can view product details.
Method URL
GET view
Response
200 OK
5. Buy now:
Here users can view loading page
Method URL
GET cart
Response
200 OK
Check Out:
1.Load check-out:
User can load checkout page
Method URL
GET checkout
Response
200 OK
2. check-out:
User can load checkout products
Method URL
GET checkout
Request:
Name Name of the user string
Address Address of the user string
Email Email of the user email
Phone No. Phone number of the user int
Response
200 OK
3. User Dashboard:
2. Account Details:
Here user can Edit account details
Method URL
POST /user/user_account
Request
Address The address of the user string
Phone No. User phone number int
Password Password for authentication password
Response
200 ’Success’.
USER LOGOUT:
Users can log out from the webpage..

Method URL
GET /user/user_logout
Response
200 OK

Untitled Document

Uploaded by

Copyright:

Available Formats

You might also like

Untitled Document

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Untitled Document

Uploaded by

Copyright:

Available Formats

API Documentation

Version Date Author Description

1.0 26-11-2022 RAMEESUL YOONUS MTP Initial draft

1. Master admin Login:

User Name Master Admin have a username String

Password Master Admin have a password Password

Parameter Name Description Type & Length

200 “Successfully Login to Master Admin pane

501 {“error”:”Username and password invalid}

Parameter Name Description Type & Length

200 ’Success’. Enter to

Parameter Name Description

Here Master admin can add a brand’s account.

Brand name Name of the brand String

Reg number Registration no of outlet int

GST no GST number of the outlet int

Email Email of the outlet email

Password Password for the account password

Parameter Name Description

Here Master Admin can edit Brands.

Brand name Name of the brand String

Reg number Registration no of outlet int

GST no GST number of the outlet int

Email Email of the outlet email

Password Password for the account password

Parameter Name Description

Here Master admin can delete or block brands.

Parameter Name Description

Email Email of the user String

Username User name of the user String

No of orders Number of orders of the user int

Complaints Complaints posted by the user String

Admin can edit details about the user..

Name Name of the user String

Username User name of the user string

Mobile number Mobile number of the user int

Email User email email

Password Password of the user password

Order details Details of orders done by user Stringj

Parameter Name Description

Admin can delete or Block users .

Parameter Name Description

1. Admin Sign Up:

Here Admin can register details and create login .

Brand name Name of the brand String

Reg number Registration no of outlet int

GST no GST number of the outlet int

Email Email of the outlet email

Password Password for the account password

User Name Admin have a username String

Password Admin have a password Password

Parameter Name Description Type & Length

200 “Successfully Login to Admin panel ”

501 {“error”:”Username and password invalid}

Parameter Name Description Type & Length

200 ’Success’. Enter to admin_Panel

Parameter Name Description