{"info":{"_postman_id":"4ee4afb2-0daf-4a9f-9698-294c28fb18f0","name":"Magnalense","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"15748545","collectionId":"4ee4afb2-0daf-4a9f-9698-294c28fb18f0","publishedId":"2s9YsFCtBn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-02T10:48:12.000Z"},"item":[{"name":"Admin","item":[{"name":"Products","item":[{"name":"Create product","id":"f6a60bcc-a60e-4d74-be41-8fc1bca7ec66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Olamides glasses\",\r\n \"price\": 29.99,\r\n \"image\": \"random_image.jpg\",\r\n \"otherImages\": [\r\n \"image2.jpg\",\r\n \"image3.jpg\"\r\n ],\r\n \"description\": \"This is a random product description.\",\r\n \"prescription\": {\r\n \"leftEye\": 2.75,\r\n \"rightEye\": 3.0\r\n },\r\n \"quantity\": \"10\",\r\n \"category\": \"Medicated Glasses\",\r\n \"frameMaterial\": \"Wood\",\r\n \"color\": \"Silver\",\r\n \"lensMaterial\": \"Glass\"\r\n // \"rating\": [\r\n // {\r\n // \"user\": \"6586eafb5b584686e45777f5\", \r\n // \"rating\": 4.5,\r\n // \"comment\": \"Random comment about the product.\"\r\n // }\r\n // ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/products","description":"

Create Product

Endpoint

POST {{host}}/products\n\n

Description

Create a new product.

Request

Method: POST
\n
URL: {{host}}/products
\n
Headers:
\n
- Content-Type: application/json
- Authorization: Required
\n

Body

Format: JSON
Required Fields:
- title (string): Title of the product.
- price (number): Price of the product.
- description (string): Description of the product.
- category (string): Category of the product.
\n

Example Request

POST http://your-api-base-url/products\nHeaders:\n  Content-Type: application/json\n  Authorization: Bearer YOUR_ACCESS_TOKEN\nBody:\n{\n  \"title\": \"RayBans\",\n  \"price\": 99.99,\n  \"description\": \"High-quality sunglasses\",\n  \"category\": \"Sunglasses\"\n}\n\n

Response

Status Codes:
- 201 Created: Product successfully created.
- 400 Bad Request: Required fields are missing or empty.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n    \"title\": \"Random Product 2\",\n    \"price\": 29.99,\n    \"image\": \"random_image.jpg\",\n    \"otherImages\": [\n        \"image2.jpg\",\n        \"image3.jpg\"\n    ],\n    \"description\": \"This is a random product description.\",\n    \"prescription\": [\n        {\n            \"leftEye\": 2.75,\n            \"rightEye\": 3,\n            \"_id\": \"65873bcbdaf66a02aa9d938b\"\n        }\n    ],\n    \"quantity\": \"10\",\n    \"category\": \"Medicated Glasses\",\n    \"frameMaterial\": \"Wood\",\n    \"color\": \"Silver\",\n    \"lensMaterial\": \"Glass\",\n    \"rating\": [],\n    \"_id\": \"65873bcbdaf66a02aa9d938a\",\n    \"createdAt\": \"2023-12-23T19:58:03.834Z\",\n    \"updatedAt\": \"2023-12-23T19:58:03.834Z\",\n    \"__v\": 0\n}\n\n

Error Response

{\n  \"message\": \"Required fields must not be empty\"\n}\n\n

\n","urlObject":{"path":["products"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6a60bcc-a60e-4d74-be41-8fc1bca7ec66"},{"name":"Delete Product","id":"f68ffd3d-59e8-4cf8-9855-f64d43f230ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{mangalenseHost}}/products/659137adaac8b6c25e4bd441","description":"

Delete a Product

Endpoint

DELETE {{host}}/products/:id\n\n

Description

Delete an existing product.

Request

Method: DELETE
\n
URL: http://your-api-base-url/products/:id
\n
Headers:
\n
- Authorization: Required
\n

URL Parameters

id (string): Product ID (required)

Example Request

DELETE http://your-api-base-url/api/products/65873b69daf66a02aa9d9380\nHeaders:\n  Authorization: Bearer YOUR_ACCESS_TOKEN\n\n

Response

Status Codes:
- 200 OK: Product successfully deleted.
- 400 Bad Request: Product ID is missing or empty.
- 404 Not Found: Product not found.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n  \"message\": \"Product deleted successfully\"\n}\n\n

Error Response

{\n  \"message\": \"Product ID is required\"\n}\n\n

\n","urlObject":{"path":["products","659137adaac8b6c25e4bd441"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f68ffd3d-59e8-4cf8-9855-f64d43f230ae"},{"name":"Update Product","id":"4eceded5-6406-4432-b53d-3275afacc609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"olamides sunglasses glasses\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/products/659300cb8f6a95c1344cec36","description":"

Update a Product

Endpoint

PUT {{host}}/products/:id\n\n

Description

Update an existing product.

Request

Method: PUT
\n
URL: http://your-api-base-url/products/:id
\n
Headers:
\n
- Content-Type: application/json
- Authorization: Required
\n

URL Parameters

id (string): Product ID (required)

Body

Format: JSON
Optional Fields:
- title (string): Title of the product.
- price (number): Price of the product.
- description (string): Description of the product.
- category (string): Category of the product.
\n

Example Request

PUT http://your-api-base-url/api/products/65873b69daf66a02aa9d9380\nHeaders:\n  Content-Type: application/json\n  Authorization: Bearer YOUR_ACCESS_TOKEN\nBody:\n{\n  \"title\": \"Updated RayBans\",\n  \"price\": 129.99,\n  \"description\": \"Updated high-quality sunglasses\",\n  \"category\": \"Sunglasses\"\n}\n\n

Response

Status Codes:
- 200 OK: Product successfully updated.
- 400 Bad Request: Product ID is missing or empty.
- 404 Not Found: Product not found.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n  \"_id\": \"65873b69daf66a02aa9d9380\",\n  \"title\": \"Updated RayBans\",\n  \"price\": 129.99,\n  \"image\": \"raybans_image.jpg\",\n  \"otherImages\": [\"image2.jpg\", \"image3.jpg\"],\n  \"description\": \"Updated high-quality sunglasses\",\n  \"prescription\": [],\n  \"quantity\": null,\n  \"category\": \"Sunglasses\",\n  \"frameMaterial\": null,\n  \"color\": null,\n  \"lensMaterial\": null,\n  \"rating\": [],\n  \"createdAt\": \"2023-12-23T19:56:25.837Z\",\n  \"updatedAt\": \"2023-12-23T20:12:34.567Z\",\n  \"__v\": 0\n}\n\n

Error Response

{\n  \"message\": \"Product ID is required\"\n}\n\n

\n","urlObject":{"path":["products","659300cb8f6a95c1344cec36"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4eceded5-6406-4432-b53d-3275afacc609"}],"id":"c6c98b83-52ae-4516-b734-d46e08b9f38f","description":"

Admin Endpoints

This folder manages administrative actions for products:

Create Product
\n
- POST /products
  \n
- Create a new product.
  \n
- Authorization: Required
  \n
- Example Request: POST /products
  \n
\n
Update Product
\n
- PUT /products/:id
  \n
- Update an existing product.
  \n
- Authorization: Required
  \n
- Example Request: PUT /products/ID
  \n
\n
Delete Product
\n
- DELETE /products/:id
  \n
- Delete an existing product.
  \n
- Authorization: Required
  \n
- Example Request: DELETE /products/ID
  \n
\n

\n","_postman_id":"c6c98b83-52ae-4516-b734-d46e08b9f38f"},{"name":"Authentication","item":[{"name":"Register","id":"09efdf40-d83d-4905-b524-ef44bc067ae5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"tosiron jegede\",\r\n \"email\":\"adminnnn@gmail.com\",\r\n \"password\":\"1234567\"\r\n\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/admin/register","description":"

Register User

Register Admin

Endpoint: POST /admin/register

Description: Registers a new admin.

Request:

Method: POST

{  \"name\": \"John Doe\",\n    \"email\":\"JohnDoeeeee@gmail.com\",\n    \"password\":\"1234567\"\n}\n\n

Responses:

{\n  \"user\": {\n    \"_id\": \"user_id\",\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"role\": \"admin\"\n  },\n  \"token\": \"admin_token\"\n}\n\n

{  \"error\": \"Please provide name, email, and password\"}\n\n

500 Internal Server Error: Server error occurred

POST /admin/register

\n","urlObject":{"path":["admin","register"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09efdf40-d83d-4905-b524-ef44bc067ae5"},{"name":"Login","id":"e107b7dc-3c75-4c94-8de3-1b639fa0c4a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"email\":\"adminnn@gmail.com\",\r\n \"password\":\"1234567\"\r\n }","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/admin/login","description":"\n

Endpoint: POST /admin/login
Description: Logs in an existing admin.
Request:

Method: POST

{ \n\"email\":\"JohnDoeee@gmail.com\",\n\"password\":\"1234567\"\n }\n\n

Responses:

{\n  \"user\": {\n    \"_id\": \"user_id\",\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"role\": \"admin\"\n  },\n  \"token\": \"admin_token\"\n}\n\n

{  \"error\": \"Admin account does not exist\"   // or  \"error\": \"You are currently suspended, Please contact the admin\"\n\n

500 Internal Server Error: Server error occurred

POST /admin/login

\n","urlObject":{"path":["admin","login"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e107b7dc-3c75-4c94-8de3-1b639fa0c4a6"},{"name":"Logout","id":"b22d5a77-92da-42c1-94b1-dcea1c5f7062","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/admin/logout","description":"

Logout Admin

Endpoint: GET /admin/logout

Description: Logs out the authenticated user.

Request:

Method: GET
\n
Auth: Required
\n

Responses:

{  \"message\": \"Logout successful\"}\n\n

 {  \"error\": \"User not found\"}\n\n

500 Internal Server Error: Server error occurred

GET /admin/logout

\n","urlObject":{"path":["admin","logout"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b22d5a77-92da-42c1-94b1-dcea1c5f7062"}],"id":"e88ec3a1-702f-4f12-af6d-c2b04b6a3642","description":"

Authentication Endpoints

This folder manages admin authentication actions.

POST /admin/register
\n
- Endpoint: POST /admin/register
- Auth: Not Required
- Description: Registers a new admin.
\n
POST /admin/login
\n
- Endpoint: POST /admin/login
- Auth: Not Required
- Description: Logs in an existing admin.
\n
GET /admin/logout
\n
- Endpoint: GET /admin/logout
- Auth: Required
- Description: Logs out the authenticated admin.
\n

\n","_postman_id":"e88ec3a1-702f-4f12-af6d-c2b04b6a3642"},{"name":"Users","item":[{"name":"Get all users","id":"6fb06aee-f665-4027-810d-bbc380c7f5b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/admin/view-users","description":"

View All Users

Endpoint: GET /admin/view-users

Auth: Required (Admin)

Description: Retrieve a list of all users.

Example Request: GET /admin/view-users

Response Status Codes:

200 OK: Successful request.
500 Internal Server Error: An error occurred on the server.

{\n    \"success\": true,\n    \"users\": [\n        {\n            \"cart\": [],\n            \"_id\": \"658dc1f2e23845c24a7f1dba\",\n            \"name\": \"John Doe\",\n            \"email\": \"JohnDoe@gmail.com\",\n            \"isSuspended\": true,\n            \"role\": \"user\",\n            \"createdAt\": \"2023-12-28T18:44:02.251Z\",\n            \"updatedAt\": \"2024-01-01T18:18:14.985Z\",\n            \"__v\": 0\n        },\n        {\n            \"cart\": [],\n            \"_id\": \"659133bcf6ae7365ecb92823\",\n            \"name\": \"John Doe\",\n            \"email\": \"JohnDoee@gmail.com\",\n            \"isSuspended\": false,\n            \"role\": \"user\",\n            \"createdAt\": \"2023-12-31T09:26:20.564Z\",\n            \"updatedAt\": \"2024-01-01T18:24:33.938Z\",\n            \"__v\": 0\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["admin","view-users"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6fb06aee-f665-4027-810d-bbc380c7f5b1"},{"name":"Suspend user","id":"ca4969e4-18e7-430c-861e-d125130f32e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{mangalenseHost}}/admin/suspend-user/658dc1f2e23845c24a7f1dba","description":"

Toggle Suspension

Endpoint: PATCH /admin/suspend-user/:userId

Auth: Required (Admin)

Description: Suspend or unsuspend a user.

Example Request: PATCH /admin/suspend-user/65873b69daf66a02aa9d9380

Response Status Codes:

200 OK: Successful request.
\n
500 Internal Server Error: An error occurred on the server.
\n

{\n \"success\": true,\n \"msg\": \"User suspended successfully\"\n}\n

\n","urlObject":{"path":["admin","suspend-user","658dc1f2e23845c24a7f1dba"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca4969e4-18e7-430c-861e-d125130f32e5"},{"name":"Get single user","id":"4d20cef0-0c0e-4130-b4e7-4da2b4e02c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/admin/view-single-user/658dc1f2e23845c24a7f1dba","description":"

View Single User

Endpoint: GET /admin/view-single-user/:userId

Auth: Required (Admin)

Description: Retrieve details of a specific user.

Example Request: GET /admin/view-single-user/65873b69daf66a02aa9d9380

Response Status Codes:

200 OK: Successful request.
500 Internal Server Error: An error occurred on the server.

 {\n    \"success\": true,\n    \"user\": {\n        \"cart\": [],\n        \"_id\": \"658dc1f2e23845c24a7f1dba\",\n        \"name\": \"John Doe\",\n        \"email\": \"JohnDoe@gmail.com\",\n        \"isSuspended\": true,\n        \"role\": \"user\",\n        \"createdAt\": \"2023-12-28T18:44:02.251Z\",\n        \"updatedAt\": \"2024-01-01T18:18:14.985Z\",\n        \"__v\": 0\n    }\n}\n

\n","urlObject":{"path":["admin","view-single-user","658dc1f2e23845c24a7f1dba"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d20cef0-0c0e-4130-b4e7-4da2b4e02c90"}],"id":"123d1a3a-b810-4eb3-a21c-a36cc06d4562","description":"

Admin Endpoints

This folder manages administrative actions for existing users:

View All Users
- Endpoint: GET /admin/view-users
- Auth: Required (Admin)
- Description: Retrieve a list of all users.
\n
View Single User
- Endpoint: GET /admin/view-single-user/:userId
- Auth: Required (Admin)
- Description: Retrieve details of a specific user.
\n
Toggle Suspension
- Endpoint: PATCH /admin/suspend-user/:userId
- Auth: Required (Admin)
- Description: Suspend or unsuspend a user.
\n

These endpoints enable admin-specific actions like viewing all users, retrieving details of a single user, and suspending/unsuspending users .

\n","_postman_id":"123d1a3a-b810-4eb3-a21c-a36cc06d4562"}],"id":"397a00e5-092c-47ac-9e5e-9a66beaf71ef","description":"

This folder contains the authentication-related endpoints for admin authentication, products, and user management

\n","_postman_id":"397a00e5-092c-47ac-9e5e-9a66beaf71ef"},{"name":"User","item":[{"name":"Products","item":[{"name":"Get all products","id":"99974ce2-a4c9-4db8-ba87-8902b944a8a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/products","description":"

GET {{host}}/products\n\n

Description

Get a list of products based on the specified search criteria.

Parameters

Query Parameters:
\n
- title (string): Title of the product. (Optional)
  \n
- color (string): Color of the product. (Optional)
  \n
- frameMaterial (string): Frame material of the product. (Optional)
  \n
- lensMaterial (string): Lens material of the product. (Optional)
  \n
- category (string): Category of the product. (Optional)
  \n
- page (number): Page number for pagination (Optional, default is 1)
  \n
\n

Authentication

This endpoint requires authentication. The user must be logged in to access it.

Example Request

GET http://your-api-base-url/products?title=RayBans&color=yourColor&Wood=yourFrameMaterial&lensMaterial=Glass&category=Sunglasses\n\n

Response

Status Codes:
- 200 OK: Successful request.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n    \"Number of Products\": 1,\n    \"products\": [\n        {\n            \"_id\": \"65873b69daf66a02aa9d9380\",\n            \"title\": \"Random Product 2\",\n            \"price\": 29.99,\n            \"image\": \"random_image.jpg\",\n            \"otherImages\": [\n                \"image2.jpg\",\n                \"image3.jpg\"\n            ],\n            \"description\": \"This is a random product description.\",\n            \"prescription\": [\n                {\n                    \"leftEye\": 2.75,\n                    \"rightEye\": 3,\n                    \"_id\": \"65873b69daf66a02aa9d9381\"\n                }\n            ],\n            \"quantity\": \"10\",\n            \"category\": \"Medicated Glasses\",\n            \"frameMaterial\": \"Wood\",\n            \"color\": \"Black\",\n            \"lensMaterial\": \"Glass\",\n            \"rating\": [],\n            \"createdAt\": \"2023-12-23T19:56:25.837Z\",\n            \"updatedAt\": \"2023-12-23T19:56:25.837Z\",\n            \"__v\": 0\n        }\n    ]\n}\n\n

\n","urlObject":{"path":["products"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"99974ce2-a4c9-4db8-ba87-8902b944a8a1"},{"name":"Get single product","id":"e8a85eb4-b944-4133-baf5-3c7dcd8b5863","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/products/659145c93f58e5d4d4dfcbfb","description":"

Get Single Product

Description

Get details of a single product by ID.

Parameters

Path Parameters:
- id (string): Product ID.
\n

Authentication

This endpoint requires authentication. The user must be logged in to access it.

Example Request

GET http://your-api-base-url/products/:id\n\n

Response

Status Codes:
- 200 OK: Successful request.
- 400 Bad Request: Product ID is required.
- 404 Not Found: Product not found.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n    \"_id\": \"65873b69daf66a02aa9d9380\",\n    \"title\": \"Random Product 2\",\n    \"price\": 29.99,\n    \"image\": \"random_image.jpg\",\n    \"otherImages\": [\n        \"image2.jpg\",\n        \"image3.jpg\"\n    ],\n    \"description\": \"This is a random product description.\",\n    \"prescription\": [\n        {\n            \"leftEye\": 2.75,\n            \"rightEye\": 3,\n            \"_id\": \"65873b69daf66a02aa9d9381\"\n        }\n    ],\n    \"quantity\": \"10\",\n    \"category\": \"Medicated Glasses\",\n    \"frameMaterial\": \"Wood\",\n    \"color\": \"Black\",\n    \"lensMaterial\": \"Glass\",\n    \"rating\": [],\n    \"createdAt\": \"2023-12-23T19:56:25.837Z\",\n    \"updatedAt\": \"2023-12-23T19:56:25.837Z\",\n    \"__v\": 0\n}\n\n

\n","urlObject":{"path":["products","659145c93f58e5d4d4dfcbfb"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8a85eb4-b944-4133-baf5-3c7dcd8b5863"}],"id":"da47d665-dec3-4579-97c2-e6989cd37b0a","description":"

User Endpoints

This folder manages User actions for products:

Get All Products
- Get /products
- fetches all existing products.
- Authorization: Not-Required
- Example Request: Get/products
\n
Get Single Product
- Get /products/:id
- fetches a product with the given ID.
- Authorization: Required
- Example Request: Get/products/:id
\n

\n","_postman_id":"da47d665-dec3-4579-97c2-e6989cd37b0a"},{"name":"Authentication","item":[{"name":"Register","id":"b2f3f297-f4a4-4a90-98b9-f194e381be14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"John Doe\",\r\n \"email\":\"JohnDoeeeee@gmail.com\",\r\n \"password\":\"1234567\"\r\n\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/user/register","description":"

Register User

Endpoint: POST /user/register

Description: Registers a new user.

Request:

Method: POST

{  \"name\": \"John Doe\",\n    \"email\":\"JohnDoeeeee@gmail.com\",\n    \"password\":\"1234567\"\n\n\n}\n\n

Responses:

{\n  \"user\": {\n    \"_id\": \"user_id\",\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"role\": \"user\",\n    \"isSuspended\": false\n  },\n  \"token\": \"user_token\"\n}\n\n\n

{  \"error\": \"Please provide name, email, and password\"}\n\n

500 Internal Server Error: Server error occurred

POST /user/register

\n","urlObject":{"path":["user","register"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2f3f297-f4a4-4a90-98b9-f194e381be14"},{"name":"Login","id":"a6387cab-1f9e-4435-8473-f8f8b158acec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"email\":\"JohnDoeee@gmail.com\",\r\n\"password\":\"1234567\"\r\n }","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/user/login","description":"\n

Endpoint: POST /user/login
Description: Logs in an existing user.
Request:

Method: POST

{ \n\"email\":\"JohnDoeee@gmail.com\",\n\"password\":\"1234567\"\n }\n\n

Responses:

{\n  \"user\": {\n    \"_id\": \"user_id\",\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"role\": \"user\",\n    \"isSuspended\": false\n  },\n  \"token\": \"user_token\"\n}\n\n

{  \"error\": \"User does not exist\"   // or  \"error\": \"You are currently suspended, Please contact the admin\"\n\n

500 Internal Server Error: Server error occurred

POST /user/login

\n","urlObject":{"path":["user","login"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6387cab-1f9e-4435-8473-f8f8b158acec"},{"name":"Logout","id":"59acc49f-6b32-44c1-af7b-b910255774af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/user/logout","description":"

Logout User

Endpoint: GET /user/logout

Description: Logs out the authenticated user.

Request:

Method: GET
Auth: Required

Responses:

{  \"message\": \"Logout successful\"}\n\n

 {  \"error\": \"User not authenticated\"}\n\n

500 Internal Server Error: Server error occurred

GET /user/logout

\n","urlObject":{"path":["user","logout"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"59acc49f-6b32-44c1-af7b-b910255774af"}],"id":"b7aba4ac-bcc0-4c31-81a6-f808f171e118","description":"

Authentication Endpoints

This folder manages user authentication actions.

POST /admin/register
\n
- Endpoint: POST /user/register
  \n
- Auth: Not Required
  \n
- Description: Registers a new user.
  \n
\n
POST /user/login
\n
- Endpoint: POST /user/login
  \n
- Auth: Not Required
  \n
- Description: Logs in an existing user.
  \n
\n
GET /auth/logout
\n
- Endpoint: GET /user/logout
  \n
- Auth: Required
  \n
- Description: Logs out the authenticated user.
  \n
\n

\n","_postman_id":"b7aba4ac-bcc0-4c31-81a6-f808f171e118"},{"name":"Cart","item":[{"name":"View Cart","id":"26ac4ee4-3239-4440-b0aa-6296fc576f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{mangalenseHost}}/cart/","description":"

View User Cart

Endpoint: GET {{host}}/cart

Description: Get the user's shopping cart.

Authentication: Required (User must be logged in).

GET http://your-api-base-url/cart

{\n    \"Number of Items in Cart\": 1,\n    \"viewCart\": {\n        \"_id\": \"6591c84737bdc16011d7f8c5\",\n        \"user\": \"659133d5f6ae7365ecb92828\",\n        \"items\": [\n            {\n                \"product\": {\n                    \"_id\": \"65913cfa177d317591d3024d\",\n                    \"title\": \"Random Product 2\",\n                    \"price\": 29.99,\n                    \"image\": \"random_image.jpg\",\n                    \"otherImages\": [\n                        \"image2.jpg\",\n                        \"image3.jpg\"\n                    ],\n                    \"description\": \"This is a random product description.\",\n                    \"prescription\": [\n                        {\n                            \"leftEye\": 2.75,\n                            \"rightEye\": 3,\n                            \"_id\": \"65913cfa177d317591d3024e\"\n                        }\n                    ],\n                    \"quantity\": \"10\",\n                    \"category\": \"Medicated Glasses\",\n                    \"frameMaterial\": \"Wood\",\n                    \"color\": \"Silver\",\n                    \"lensMaterial\": \"Glass\",\n                    \"totalRatings\": 4,\n                    \"averageRating\": 3.5,\n                    \"createdAt\": \"2023-12-31T10:05:46.588Z\",\n                    \"updatedAt\": \"2023-12-31T10:07:16.699Z\",\n                    \"__v\": 4\n                },\n                \"price\": 29.99,\n                \"quantity\": 1,\n                \"_id\": \"6593ddf0821a1783ca861d3a\"\n            }\n        ],\n        \"total\": 29.99,\n        \"createdAt\": \"2023-12-31T20:00:07.857Z\",\n        \"updatedAt\": \"2024-01-02T09:57:04.073Z\",\n        \"__v\": 10\n    }\n}\n\n

\n","urlObject":{"path":["cart",""],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"26ac4ee4-3239-4440-b0aa-6296fc576f02"},{"name":"Add to Cart","id":"bc8477d8-8e03-4277-a3c0-e346f0ed1f29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{mangalenseHost}}/cart/65913cfa177d317591d3024d","description":"

Add to Cart

Endpoint: POST {{host}}/cart/:productId

Description: Add a product to the user's shopping cart.

Authentication: Required (User must be logged in).

POST http://your-api-base-url/cart/product123

{\n    \"msg\": \"Item added successfully\",\n    \"userCart\": {\n        \"_id\": \"6591c84737bdc16011d7f8c5\",\n        \"user\": \"659133d5f6ae7365ecb92828\",\n        \"items\": [\n            {\n                \"product\": \"65913cfa177d317591d3024d\",\n                \"price\": 29.99,\n                \"quantity\": 1,\n                \"_id\": \"6593dd1e081a62e9a3e54e7f\"\n            }\n        ],\n        \"total\": 29.99,\n        \"createdAt\": \"2023-12-31T20:00:07.857Z\",\n        \"updatedAt\": \"2024-01-02T09:53:34.302Z\",\n        \"__v\": 8\n    }\n}\n

\n","urlObject":{"path":["cart","65913cfa177d317591d3024d"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc8477d8-8e03-4277-a3c0-e346f0ed1f29"},{"name":"Increase Quantity","id":"52901722-1c74-4382-a369-265b776de318","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{mangalenseHost}}/cart/increase/65913cfa177d317591d3024d","description":"

Increase Quantity

Endpoint: PATCH {{host}}/cart/increase/:productId

Description: Increase the quantity of a product in the user's shopping cart.

Authentication: Required (User must be logged in).

PATCH http://your-api-base-url/cart/increase/product123

{\n    \"_id\": \"6591c84737bdc16011d7f8c5\",\n    \"user\": \"659133d5f6ae7365ecb92828\",\n    \"items\": [\n        {\n            \"product\": \"65913cfa177d317591d3024d\",\n            \"price\": 29.99,\n            \"quantity\": 3,\n            \"_id\": \"6593dc642fe2fb32835393c5\"\n        }\n    ],\n    \"total\": 89.97,\n    \"createdAt\": \"2023-12-31T20:00:07.857Z\",\n    \"updatedAt\": \"2024-01-02T09:51:17.027Z\",\n    \"__v\": 6\n}\n\n

\n","urlObject":{"path":["cart","increase","65913cfa177d317591d3024d"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"52901722-1c74-4382-a369-265b776de318"},{"name":"Decrease Quantity","id":"7680d2d3-46ba-4a4a-801c-671f04f1cca3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{mangalenseHost}}/cart/decrease/65913cfa177d317591d3024d","description":"

Decrease Quantity

Endpoint: PATCH {{host}}/cart/decrease/:productId

Description: Decrease the quantity of a product in the user's shopping cart.

Authentication: Required (User must be logged in).

PATCH http://your-api-base-url/cart/decrease/product123

{\n    \"_id\": \"6591c84737bdc16011d7f8c5\",\n    \"user\": \"659133d5f6ae7365ecb92828\",\n    \"items\": [\n        {\n            \"product\": \"65913cfa177d317591d3024d\",\n            \"price\": 29.99,\n            \"quantity\": 1,\n            \"_id\": \"6593dc642fe2fb32835393c5\"\n        }\n    ],\n    \"total\": 29.99,\n    \"createdAt\": \"2023-12-31T20:00:07.857Z\",\n    \"updatedAt\": \"2024-01-02T09:51:41.494Z\",\n    \"__v\": 6\n}\n\n

\n","urlObject":{"path":["cart","decrease","65913cfa177d317591d3024d"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7680d2d3-46ba-4a4a-801c-671f04f1cca3"},{"name":"Remove from cart","id":"74c0c26b-4213-49a5-89b0-8e741afb7b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{mangalenseHost}}/cart/65913cfa177d317591d3024d","description":"

StartFragment

Remove Cart Item

Endpoint: DELETE {{host}}/cart/:productId

Description: Remove a product from the user's shopping cart

Authentication: Required (User must be logged in).

DELETE http://your-api-base-url/cart/product123

{\n    \"msg\": \"Item removed successfully\",\n    \"userCart\": {\n        \"_id\": \"6591c84737bdc16011d7f8c5\",\n        \"user\": \"659133d5f6ae7365ecb92828\",\n        \"items\": [],\n        \"total\": 0,\n        \"createdAt\": \"2023-12-31T20:00:07.857Z\",\n        \"updatedAt\": \"2024-01-02T09:55:52.877Z\",\n        \"__v\": 9\n    }\n}\n\n

\n","urlObject":{"path":["cart","65913cfa177d317591d3024d"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"74c0c26b-4213-49a5-89b0-8e741afb7b9e"}],"id":"d8dd991c-0a59-492a-852c-e44a0a055890","description":"

User Endpoints

This folder manages User actions for the shopping cart:

View Cart
- Endpoint: GET /cart
- Auth: Required
- Description: Retrieve the user's shopping cart.
- Example Request: GET /cart
\n
Add to Cart
- Endpoint: POST /cart/:productId
- Auth: Required
- Description: Add a product to the shopping cart.
- Example Request: POST /cart/:productId
\n
Remove Item from Cart
- Endpoint: DELETE /cart/:productId
- Auth: Required
- Description: Remove a product from the shopping cart.
- Example Request: DELETE /cart/:productId
\n
Increase Item Quantity
- Endpoint: PATCH /cart/increase/:productId
- Auth: Required
- Description: Increase the quantity of a specific product in the shopping cart.
- Example Request: PATCH /cart/increase/:productId
\n
Decrease Item Quantity
- Endpoint: PATCH /cart/decrease/:productId
- Auth: Required
- Description: Decrease the quantity of a specific product in the shopping cart.
- Example Request: PATCH /cart/decrease/:productId
\n

These endpoints allow users to manage their shopping cart, including viewing, adding, removing, and adjusting the quantity of items.

\n","_postman_id":"d8dd991c-0a59-492a-852c-e44a0a055890"},{"name":"Reviews","item":[{"name":"Update Review","id":"90e3afe0-a706-49ca-b52d-a162c910b38c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"rating\":3.5,\r\n \"comment\":\"very wonderful glasses\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/products/review/659145c93f58e5d4d4dfcbfb/update-review/65914cbcd59578b4a8e25c2b","description":"

Update Review

Description

Update a review for a specific product.

Parameters

Path Parameters:
- productId (string): Product ID.
- reviewId (string): Review ID.
\n

Authentication

This endpoint requires authentication. The user must be logged in to access it.

Example Request

PATCH http://your-api-base-url/products/review/:productId/update-review/:reviewId\n\n

Request Body

{\n  \"rating\": 4.8,\n  \"comment\": \"Updated review!\"\n}\n\n

Response

Status Codes:
- 200 OK: Review updated successfully.
- 400 Bad Request: Product ID, review ID, and either rating, comment, or both, and user ID are required.
- 404 Not Found: Product not found or no reviews found for the product.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n    \"message\": \"Review updated successfully\",\n    \"totalRatings\": 1,\n    \"averageRating\": 4.8\n}\n\n

\n","urlObject":{"path":["products","review","659145c93f58e5d4d4dfcbfb","update-review","65914cbcd59578b4a8e25c2b"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"90e3afe0-a706-49ca-b52d-a162c910b38c"},{"name":"Delete Review","id":"0f36bf2f-980b-4943-8106-9ca58d378388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{mangalenseHost}}/products/review/659145c93f58e5d4d4dfcbfb/delete-review/65914b43745416fad648dbe4","description":"

Delete Review

Description

Delete a review for a specific product.

Parameters

Path Parameters:
- productId (string): Product ID.
- reviewId (string): Review ID.
\n

Authentication

This endpoint requires authentication. The user must be logged in to access it.

Example Request

DELETE http://your-api-base-url/products/review/:productId/delete-review/:reviewId\n\n

Response

Status Codes:
- 200 OK: Review deleted successfully.
- 400 Bad Request: Product ID, Review ID, and User ID are required.
- 404 Not Found: Review not found or no permission to delete this review.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n    \"message\": \"Review deleted successfully\",\n    \"totalRatings\": 0,\n    \"averageRating\": 0\n}\n\n

\n","urlObject":{"path":["products","review","659145c93f58e5d4d4dfcbfb","delete-review","65914b43745416fad648dbe4"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f36bf2f-980b-4943-8106-9ca58d378388"},{"name":"Add Review","id":"0552133f-9fc1-4de4-be2a-f930e84bc178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"rating\":5,\r\n \"comment\":\"very bad glasses from olamide\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mangalenseHost}}/products/review/659300cb8f6a95c1344cec36","description":"

Add Review

Description

Add a review for a specific product.

Parameters

Path Parameters:
- productId (string): Product ID.
\n

Authentication

This endpoint requires authentication. The user must be logged in to access it.

Example Request

POST http://your-api-base-url/products/review/:productId\n\n

Request Body

{\n  \"rating\": 4.5,\n  \"comment\": \"This is a great product!\"\n}\n\n

Response

Status Codes:
- 201 Created: Review added successfully.
- 400 Bad Request: Product ID, rating, comment, and user ID are required.
- 404 Not Found: Product not found.
- 500 Internal Server Error: An error occurred on the server.
\n

Example Response

{\n    \"message\": \"Review added successfully\",\n    \"totalRatings\": 1,\n    \"averageRating\": 4.5\n}\n\n

\n","urlObject":{"path":["products","review","659300cb8f6a95c1344cec36"],"host":["{{mangalenseHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0552133f-9fc1-4de4-be2a-f930e84bc178"}],"id":"db947706-d794-460f-925b-09dc18a1823e","description":"

User Endpoints

This folder manages User actions for reviews:

1. Add Review

Endpoint: POST /products/review/:productId
Auth: Required
POST /products/review/:productId

2. Update Review

Endpoint: PATCH /products/review/:productId/update-review/:reviewId
Auth: Required
PATCH /products/review/:productId/update-review/:reviewId

3. Delete Review

Endpoint: DELETE /products/review/:productId/delete-review/:reviewId
Auth: Required
DELETE /products/review/:productId/delete-review/:reviewId

\n","_postman_id":"db947706-d794-460f-925b-09dc18a1823e"}],"id":"e5d83eb7-3a2f-4848-9bdb-e82495387965","description":"

This folder contains the authentication-related endpoints for user authentication, products, cart and reviews

\n","_postman_id":"e5d83eb7-3a2f-4848-9bdb-e82495387965"}]}

Create Product

Endpoint

Description

Request

Body

Example Request

Response

Example Response

Error Response

Delete a Product

Endpoint

Description

Request

URL Parameters

Example Request

Response

Example Response

Error Response

Update a Product

Endpoint

Description

Request

URL Parameters

Body

Example Request

Response

Example Response

Error Response

Admin Endpoints

Register User

Register Admin

Login Admin

Logout Admin

Authentication Endpoints

View All Users

Toggle Suspension

View Single User

Admin Endpoints

Description

Parameters

Authentication

Example Request

Response

Example Response

Get Single Product

Description

Parameters

Authentication

Example Request

Response

Example Response

User Endpoints

Register User

Login User

Logout User

Authentication Endpoints

View User Cart

Add to Cart

Increase Quantity

Decrease Quantity

Remove Cart Item

User Endpoints

Update Review

Description

Parameters

Authentication

Example Request

Request Body

Response

Example Response

Delete Review

Description

Parameters

Authentication

Example Request

Response

Example Response

Add Review

Description

Parameters