{"info":{"_postman_id":"cb912ca1-c109-4b0b-adb0-7ddc80ee780f","name":"MERN  AUCTION  PLATFORM","description":"<html><head></head><body><p><strong>MERN Auction Platform</strong> is a dynamic <strong>online bidding system</strong> built with <strong>MongoDB, Express.js, React, and Node.js (MERN Stack)</strong>. It provides a <strong>secure and transparent</strong> environment where users can participate in <strong>live auctions</strong> seamlessly.</p>\n<h3 id=\"🔹-key-roles--features\"><strong>🔹 Key Roles &amp; Features</strong></h3>\n<h3 id=\"🏆-auctioneer\">🏆 <strong>Auctioneer</strong></h3>\n<p>🔹 Create <strong>auctions</strong> for products/services with details like starting price, bid increments, and duration.<br>🔹 <strong>Edit or delete</strong> auctions before bidding begins.<br>🔹 <strong>Monitor live</strong> bidding activity and auction progress.</p>\n<h3 id=\"🎯-bidder\">🎯 <strong>Bidder</strong></h3>\n<p>🔹 Browse <strong>active auctions</strong> and place competitive <strong>bids</strong>.<br>🔹 Engage in <strong>real-time bidding</strong> against other users.<br>🔹 <strong>Win auctions</strong> and view bid history in the dashboard.</p>\n<h3 id=\"🛡️-super-admin\">🛡️ <strong>Super Admin</strong></h3>\n<p>🔹 <strong>Manage the platform</strong>, oversee users &amp; control auctions.<br>🔹 <strong>Ban, approve, or remove users</strong> if needed.<br>🔹 Monitor <strong>bidding activities</strong> to ensure fair play.</p>\n<hr>\n<h3 id=\"⚡-additional-features\"><strong>⚡ Additional Features</strong></h3>\n<p>✅ <strong>Real-time Bidding</strong> 🎥 – Live updates for ongoing auctions.<br>✅ <strong>Secure Authentication</strong> 🔐 – Role-based access with JWT.<br>✅ <strong>Transaction History</strong> 📜 – Auctioneers &amp; Bidders can track their activity.<br>✅ <strong>Email Notifications</strong> 📩 – Alerts for bids, wins &amp; updates.<br>✅ <strong>User-friendly Dashboard</strong> 🖥️ – Easy navigation for all users.</p>\n<p>The <strong>MERN Auction Platform</strong> ensures a <strong>fair, engaging, and efficient</strong> <strong>bidding experience</strong> for all users, making online auctions more interactive than ever! 🚀🔥</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39190423","collectionId":"cb912ca1-c109-4b0b-adb0-7ddc80ee780f","publishedId":"2sAYdeKrLc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-24T20:15:27.000Z"},"item":[{"name":"USER ROUTES","item":[{"name":"REGISTER","id":"45c8e462-4a79-4f3d-9155-423623f20211","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"userName","value":"Jeevan Kadam","type":"text","uuid":"83c3cb14-a170-4f51-b018-dc712ac3b650"},{"key":"email","value":"jeevan123@gmail.com","type":"text","uuid":"2af90251-4ed0-4d73-bd64-5cc75a55b7e1"},{"key":"Phone","value":"9021557571","type":"text","uuid":"bde37b3b-6c16-4172-9929-185c2dd0db12"},{"key":"password","value":"1234568","type":"text","uuid":"ff2c425a-fa9c-4ffe-b9eb-8fc6ac9b8dd4"},{"key":"role","value":"Auctioner","type":"text","uuid":"903b8411-0d7c-40a5-a563-3ca1be1a37ab"},{"key":"address","value":"Gujrat","type":"text","uuid":"28a55d01-057b-4b24-b581-e64989213247"},{"key":"bankAccountNumber","value":"cnrbbanknarayangaon0335266325566","type":"text","uuid":"4bb15e8f-6f05-4638-b87b-f5b13510cd0e"},{"key":"bankAccountName","value":"Jeevan Kadam","type":"text","uuid":"e34dd0b4-d5d4-479f-b387-c2ba0901beec"},{"key":"bankName","value":"Canara Bank","type":"text","uuid":"b931d9c2-607b-4a3a-b823-83802a3323cc"},{"key":"easypaisaAccountNumber","value":"03356932","type":"text","uuid":"fe04beb2-64f7-4237-bc3a-307f7d11df08"},{"key":"paypalEmail","value":"jeevan123@gmail.com","type":"text","uuid":"d1b39ac9-90a2-4579-9982-ac9652f38028"},{"key":"profileImage","type":"file","uuid":"bf209690-7f94-43d6-b78c-05ae9ff65201","src":"/C:/Users/jeevan/Pictures/Saved Pictures/bonafide.jpg"}]},"url":"http://localhost:5000/api/v1/user/register","description":"<h4 id=\"🔹-post---register-a-new-user\"><strong>🔹 POST - Register a New User</strong></h4>\n<p>📌 <strong>Endpoint:</strong><br /><code>http://localhost:5000/api/v1/user/register</code><br />📌 <strong>Description:</strong><br />Allows new users (Auctioneer or Bidder) to create an account. Requires details like name, email, password, and role.</p>\n<p>📌 <strong>Response:</strong><br />✅ Success: Returns user data and authentication token.<br />❌ Error: Email already exists or validation fails.</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","user","register"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"45c8e462-4a79-4f3d-9155-423623f20211"},{"name":"Login","id":"7495447b-eaff-4957-8740-2c81513eb4fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:5000/api/v1/user/login","description":"<p>📌 <strong>Endpoint:</strong><br /><code>http://localhost:5000/api/v1/user/login</code><br />📌 <strong>Description:</strong><br />Authenticates a user and provides a JWT token for secure access.</p>\n<p>📌 <strong>Response:</strong><br />✅ Success: Returns JWT token and user details.<br />❌ Error: Incorrect email or password</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","user","login"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7495447b-eaff-4957-8740-2c81513eb4fb"},{"name":"FETCH LEADERBOARD","id":"02999e8e-e8e3-4b2f-afdf-6b322f71a237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h4 id=\"🔹-get---fetch-leaderboard\"><strong>🔹 GET - Fetch Leaderboard</strong></h4>\n<p>📌 <strong>Endpoint:</strong><br /><code>http://localhost:5000/api/v1/user/leaderboard</code><br />📌 <strong>Description:</strong><br />Retrieves the <strong>top bidders or auctioneers</strong> based on auction activity.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit[\n  {\n    \"rank\": 1,\n    \"user\": \"Alice\",\n    \"bidsPlaced\": 50\n  },\n  {\n    \"rank\": 2,\n    \"user\": \"Bob\",\n    \"bidsPlaced\": 45\n  }\n]\n\n</code></pre>","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"02999e8e-e8e3-4b2f-afdf-6b322f71a237"},{"name":"GET PROFILE","id":"b53982b8-06cd-40af-860e-7adb2772e8fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5000/api/v1/user/me","description":"<p>StartFragment</p>\n<h4 id=\"🔹-get---fetch-user-profile\"><strong>🔹 GET - Fetch User Profile</strong></h4>\n<p>📌 <strong>Endpoint:</strong><br /><code>http://localhost:5000/api/v1/user/me</code><br />📌 <strong>Description:</strong><br />Retrieves the authenticated user’s profile details.</p>\n<p>📌 <strong>Headers Required:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"Authorization\": \"Bearer your_jwt_token\"\n}\n\n</code></pre><p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"id\": \"12345\",\n  \"name\": \"John Doe\",\n  \"email\": \"johndoe@example.com\",\n  \"role\": \"bidder\",\n  \"auctionsWon\": 3\n\n</code></pre><p>EndFragment</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","user","me"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b53982b8-06cd-40af-860e-7adb2772e8fe"},{"name":"LOGOUT","id":"5843dfff-710f-4574-bbd2-0958a6087dba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<p>StartFragment</p>\n<h4 id=\"🔹-get---logout\"><strong>🔹 GET - Logout</strong></h4>\n<p>📌 <strong>Endpoint:</strong><br /><code>http://localhost:5000/api/v1/user/logout</code><br />📌 <strong>Description:</strong><br />Logs out the user by clearing the session/token from storage.</p>\n<p>📌 <strong>Response:</strong><br />✅ Success: <code>\"message\": \"Logged out successfully\"</code><br />❌ Error: User not authenticated.</p>\n<p>EndFragment</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"5843dfff-710f-4574-bbd2-0958a6087dba"}],"id":"600f39dc-3763-4ce6-b60f-28d4ba201739","description":"<h3 id=\"🛠️-user-routes--mern-auction-platform-api\"><strong>🛠️ User Routes – MERN Auction Platform API</strong></h3>\n<p>These API endpoints handle <strong>user authentication, profile management, and leaderboard fetching</strong>.</p>\n","_postman_id":"600f39dc-3763-4ce6-b60f-28d4ba201739"},{"name":"AUCTION  ROUTES","item":[{"name":"ADD NEW AUCTION ITEM","id":"588a33bf-4b61-4ffe-8cb0-83871a68e7a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"<h3 id=\"📝-post---add-new-auction-item\"><strong>📝 POST - Add New Auction Item</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>POST http://localhost:5000/api/v1/auctionitem/add</code><br />📌 <strong>Description:</strong><br />Allows an <strong>Auctioneer</strong> to create a new auction item.</p>\n<p>📌 <strong>Request Body (JSON Example):</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"title\": \"Luxury Watch\",\n  \"description\": \"A high-end Rolex watch in mint condition.\",\n  \"startingPrice\": 5000,\n  \"bidIncrement\": 200,\n  \"endTime\": \"2025-03-15T20:00:00.000Z\",\n  \"image\": \"watch-image-url\"\n}\n\n</code></pre><p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Auction item added successfully\",\n  \"auctionItem\": {\n    \"id\": \"67b0e4910f6520ec8ed59307\",\n    \"title\": \"Luxury Watch\",\n    \"startingPrice\": 5000,\n    \"status\": \"active\"\n  }\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Auction item added.<br />❌ <strong>Error:</strong> Invalid data or unauthorized access.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"588a33bf-4b61-4ffe-8cb0-83871a68e7a8"},{"name":"GET ALL AUCTION  ITEMS","id":"b4f6a4b0-375d-4ad6-b021-cb10585fcbc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h3 id=\"📌-get---fetch-all-auction-items\"><strong>📌 GET - Fetch All Auction Items</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/auctionitem/all</code><br />📌 <strong>Description:</strong><br />Retrieves a list of all <strong>active auction items</strong> available for bidding.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit[\n  {\n    \"id\": \"67b0e4910f6520ec8ed59307\",\n    \"title\": \"Luxury Watch\",\n    \"startingPrice\": 5000,\n    \"currentBid\": 5200,\n    \"endTime\": \"2025-03-15T20:00:00.000Z\",\n    \"status\": \"active\"\n  },\n  {\n    \"id\": \"67b0e4910f6520ec8ed59308\",\n    \"title\": \"MacBook Pro\",\n    \"startingPrice\": 1200,\n    \"currentBid\": 1400,\n    \"endTime\": \"2025-03-18T18:00:00.000Z\",\n    \"status\": \"active\"\n  }\n]\n\n</code></pre><p>✅ <strong>Success:</strong> Returns all auction items.<br />❌ <strong>Error:</strong> No active auctions found.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b4f6a4b0-375d-4ad6-b021-cb10585fcbc0"},{"name":"AUCTION ITEM DETAILS","id":"39b20afd-fa1e-4d96-b73b-b146c6fa8132","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h3 id=\"🔍-get---auction-item-details\"><strong>🔍 GET - Auction Item Details</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/auctionitem/:id</code><br />📌 <strong>Description:</strong><br />Fetches details about a specific <strong>auction item</strong> including its current status, bids, and auctioneer details.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"id\": \"67b0e4910f6520ec8ed59307\",\n  \"title\": \"Luxury Watch\",\n  \"description\": \"A high-end Rolex watch in mint condition.\",\n  \"startingPrice\": 5000,\n  \"currentBid\": 5200,\n  \"bids\": [\n    { \"bidder\": \"Alice\", \"amount\": 5100 },\n    { \"bidder\": \"Bob\", \"amount\": 5200 }\n  ],\n  \"status\": \"active\"\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Returns auction item details.<br />❌ <strong>Error:</strong> Auction item not found.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"39b20afd-fa1e-4d96-b73b-b146c6fa8132"},{"name":"GET MY AUCTIONS","id":"8cf5c441-2b60-4d29-bb18-7aaaeb065ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5000/api/v1/auctionitem/myitems","description":"<h3 id=\"🛍️-get---get-my-auctions-auctioneer-only\"><strong>🛍️ GET - Get My Auctions (Auctioneer Only)</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/auctionitem/myitems</code><br />📌 <strong>Description:</strong><br />Retrieves a list of <strong>all auctions created by the logged-in Auctioneer</strong>.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit[\n  {\n    \"id\": \"67b0e4910f6520ec8ed59307\",\n    \"title\": \"Luxury Watch\",\n    \"startingPrice\": 5000,\n    \"currentBid\": 5200,\n    \"status\": \"active\"\n  },\n  {\n    \"id\": \"67b0e4910f6520ec8ed59309\",\n    \"title\": \"Gaming Laptop\",\n    \"startingPrice\": 1500,\n    \"currentBid\": 1800,\n    \"status\": \"sold\"\n  }\n]\n\n</code></pre><p>✅ <strong>Success:</strong> Returns auctioneer’s auction items.<br />❌ <strong>Error:</strong> No auctions found.</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","auctionitem","myitems"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cf5c441-2b60-4d29-bb18-7aaaeb065ad9"},{"name":"DELETE AUCTION ITEM","id":"e81596e3-70c1-4e47-b132-5255c744280a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h3 id=\"🗑️-delete---remove-an-auction-item-auctioneer-only\"><strong>🗑️ DELETE - Remove an Auction Item (Auctioneer Only)</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>DELETE http://localhost:5000/api/v1/auctionitem/:id</code><br />📌 <strong>Description:</strong><br />Allows an <strong>Auctioneer</strong> to delete an auction <strong>(only if bidding has not started).</strong></p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Auction item deleted successfully\"\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Auction item removed.<br />❌ <strong>Error:</strong> Item already has bids or unauthorized access.</p>\n<p>EndFragment</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"e81596e3-70c1-4e47-b132-5255c744280a"},{"name":"REPUBLISH ITEM","id":"fb51cdd8-70ff-425a-966d-66fee84c80e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/v1/auctionitem/item/republish/67b0e4910f6520ec8ed59307","description":"<p>StartFragment</p>\n<h3 id=\"🔄-put---republish-an-auction-item\"><strong>🔄 PUT - Republish an Auction Item</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>PUT http://localhost:5000/api/v1/auctionitem/item/republish/67b0e4910f6520ec8ed59307</code><br />📌 <strong>Description:</strong><br />Allows an <strong>Auctioneer</strong> to republish an auction item that was previously closed or unsold.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Auction item republished successfully\",\n  \"auctionItem\": {\n    \"id\": \"67b0e4910f6520ec8ed59307\",\n    \"status\": \"active\"\n  }\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Auction item is live again.<br />❌ <strong>Error:</strong> Item is already active or unauthorized action.</p>\n<p>EndFragment</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","auctionitem","item","republish","67b0e4910f6520ec8ed59307"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb51cdd8-70ff-425a-966d-66fee84c80e6"}],"id":"7f152a6c-f226-49a8-8626-f202ef9575af","description":"<h3 id=\"⚡-auction-routes--mern-auction-platform-api\"><strong>⚡ AUCTION ROUTES – MERN AUCTION PLATFORM API</strong></h3>\n<p>These API endpoints allow <strong>Auctioneers</strong> to manage auctions and <strong>Bidders</strong> to view and participate in live auctions. 🚀🔥</p>\n","_postman_id":"7f152a6c-f226-49a8-8626-f202ef9575af"},{"name":"BID ROUTES","item":[{"name":"PLACE BID","id":"d6332c90-44fa-4d88-9900-827be599a006","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"amount","value":"16001","type":"text","uuid":"d67ff8dd-7819-4162-871c-f8cebf401495"}]},"url":"http://localhost:5000/api/v1/bid/place/67b1cf8a7dea39414602b10a","description":"<p>StartFragment</p>\n<h3 id=\"🔹-place-a-bid-bidder-only\"><strong>🔹 Place a Bid (Bidder Only)</strong></h3>\n<h4 id=\"📌-post---place-a-bid\"><strong>📌 POST - Place a Bid</strong></h4>\n<p>📌 <strong>Endpoint:</strong><br /><code>POST http://localhost:5000/api/v1/bid/place/67b1cf8a7dea39414602b10a</code></p>\n<p>📌 <strong>Description:</strong><br />Allows a <strong>Bidder</strong> to place a bid on an active auction item.</p>\n<p>📌 <strong>Request Body (Example):</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"amount\": 5300\n}\n\n</code></pre><p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Bid placed successfully\",\n  \"auctionItem\": {\n    \"id\": \"67b1cf8a7dea39414602b10a\",\n    \"currentBid\": 5300,\n    \"bidder\": \"John Doe\",\n    \"status\": \"active\"\n  }\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Bid successfully placed.<br />❌ <strong>Error:</strong> Bid amount is too low, auction is closed, or unauthorized access.</p>\n<p>EndFragment</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","bid","place","67b1cf8a7dea39414602b10a"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6332c90-44fa-4d88-9900-827be599a006"}],"id":"53d5d8f2-9243-4cfb-975d-da77d4a6f8bb","description":"<p>StartFragment</p>\n<h3 id=\"💰-bid-routes--mern-auction-platform-api\"><strong>💰 BID ROUTES – MERN AUCTION PLATFORM API</strong></h3>\n<p>These API endpoints allow <strong>Bidders</strong> to place bids on auction items and track their bidding history. 🚀🔥</p>\n<p>EndFragment</p>\n","_postman_id":"53d5d8f2-9243-4cfb-975d-da77d4a6f8bb"},{"name":"COMMISSION ROUTES","item":[{"name":"POST COMMISSION","id":"511aa1b7-3b96-49d1-822b-2e36b3795d53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"proof","type":"file","uuid":"727efeb3-c22b-4a6f-b53c-013e29dfc936","src":"/C:/Users/jeevan/Downloads/thread-199855407-12360691436464632027.png"},{"key":"amount","value":"300","type":"text","uuid":"a0a2c684-cd87-44d5-91fa-c2367e0809ef"},{"key":"comment","value":"i am paying my commission via phonepay","type":"text","uuid":"174109ff-973f-48ad-8e68-504397ead5b1"}]},"url":"http://localhost:5000/api/v1/commission/proof","description":"<p>StartFragment</p>\n<p>📌 <strong>Endpoint:</strong><br /><code>POST http://localhost:5000/api/v1/commission/add</code></p>\n<p>📌 <strong>Description:</strong><br />Allows the <strong>Super Admin</strong> to set or update the platform commission percentage.</p>\n<p>✅ <strong>Success:</strong> Commission rate set or updated.<br />❌ <strong>Error:</strong> Unauthorized access or invalid commission rate.</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","commission","proof"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"511aa1b7-3b96-49d1-822b-2e36b3795d53"}],"id":"e6e448dc-1d9c-4466-b20e-2760aaf44730","description":"<p>StartFragment</p>\n<h3 id=\"💰-commission-routes--mern-auction-platform-api\"><strong>💰 COMMISSION ROUTES – MERN AUCTION PLATFORM API</strong></h3>\n<p>These API endpoints handle <strong>commission management</strong> for the platform, ensuring that a percentage of each successful bid goes to the platform as commission. 🚀💼</p>\n<p>EndFragment</p>\n","_postman_id":"e6e448dc-1d9c-4466-b20e-2760aaf44730"},{"name":"SUPER ADMIN ROUTES","item":[{"name":"DELETE  AUCTION  ITEM","id":"37b858c6-37c7-4a5b-997b-5e216fddeee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:5000/api/v1/superadmin/delete/","description":"<h3 id=\"🗑️-delete---remove-an-auction-item\"><strong>🗑️ DELETE - Remove an Auction Item</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>DELETE http://localhost:5000/api/v1/superadmin/auctionitem/:id</code><br />📌 <strong>Description:</strong><br />Allows the <strong>Super Admin</strong> to <strong>delete any auction item</strong> from the platform.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Auction item deleted successfully\"\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Auction item removed.<br />❌ <strong>Error:</strong> Auction item not found or unauthorized access.</p>\n","urlObject":{"protocol":"http","port":"5000","path":["api","v1","superadmin","delete",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"37b858c6-37c7-4a5b-997b-5e216fddeee0"},{"name":"GET ALL PAYMENT PROOFS","id":"f3cd4ec8-0169-48e5-8d95-0385784159b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h2 id=\"🔹-payment-management\"><strong>🔹 Payment Management</strong></h2>\n<h3 id=\"📜-get---fetch-all-payment-proofs\"><strong>📜 GET - Fetch All Payment Proofs</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/superadmin/paymentproofs</code><br />📌 <strong>Description:</strong><br />Retrieves all <strong>submitted payment proofs</strong> for auction transactions.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit[\n  {\n    \"id\": \"67b2cf8a7dea39414602b10a\",\n    \"bidder\": \"John Doe\",\n    \"amount\": 5000,\n    \"status\": \"Pending\"\n  },\n  {\n    \"id\": \"67b2cf8a7dea39414602b10b\",\n    \"bidder\": \"Alice\",\n    \"amount\": 7000,\n    \"status\": \"Approved\"\n  }\n]\n\n</code></pre><p>✅ <strong>Success:</strong> Returns all payment proofs.<br />❌ <strong>Error:</strong> No payment proofs found.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"f3cd4ec8-0169-48e5-8d95-0385784159b2"},{"name":"GET PAYMENT PROOF  DETAILS","id":"ca69d4d0-5852-4374-b790-f28873304efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h3 id=\"🔍-get---get-payment-proof-details\"><strong>🔍 GET - Get Payment Proof Details</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/superadmin/paymentproof/:id</code><br />📌 <strong>Description:</strong><br />Fetches details of a <strong>specific payment proof</strong> submitted by a bidder.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"id\": \"67b2cf8a7dea39414602b10a\",\n  \"bidder\": \"John Doe\",\n  \"amount\": 5000,\n  \"status\": \"Pending\",\n  \"proofImage\": \"payment-proof-url\"\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Returns payment proof details.<br />❌ <strong>Error:</strong> Payment proof not found.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ca69d4d0-5852-4374-b790-f28873304efd"},{"name":"UPDATE PAYMENT PROOF","id":"3c87f5ed-341c-4c63-9378-58f9603febfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"description":"<h3 id=\"✅-put---update-payment-proof-status\"><strong>✅ PUT - Update Payment Proof Status</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>PUT http://localhost:5000/api/v1/superadmin/paymentproof/:id</code><br />📌 <strong>Description:</strong><br />Allows the <strong>Super Admin</strong> to update the <strong>status</strong> of a submitted payment proof (e.g., Approved, Rejected).</p>\n<p>📌 <strong>Request Body (Example):</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"status\": \"Approved\"\n}\n\n</code></pre><p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Payment proof updated successfully\",\n  \"status\": \"Approved\"\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Payment proof updated.<br />❌ <strong>Error:</strong> Invalid status or unauthorized access.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"3c87f5ed-341c-4c63-9378-58f9603febfc"},{"name":"DELETE PAYMENT PROOF","id":"d4dfa99f-1bab-4b99-a572-875e1225213b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h3 id=\"🗑️-delete---remove-a-payment-proof\"><strong>🗑️ DELETE - Remove a Payment Proof</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>DELETE http://localhost:5000/api/v1/superadmin/paymentproof/:id</code><br />📌 <strong>Description:</strong><br />Allows the <strong>Super Admin</strong> to delete a <strong>fraudulent or invalid payment proof</strong> from the system.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"message\": \"Payment proof deleted successfully\"\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Payment proof removed.<br />❌ <strong>Error:</strong> Payment proof not found.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d4dfa99f-1bab-4b99-a572-875e1225213b"},{"name":"FETCH ALL FILTERED USERS","id":"e83c8ea7-be76-4bda-b7fa-6484a3d23e11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h2 id=\"🔹-user-management\"><strong>🔹 User Management</strong></h2>\n<h3 id=\"🔍-get---fetch-all-filtered-users\"><strong>🔍 GET - Fetch All Filtered Users</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/superadmin/users?role=bidder</code><br />📌 <strong>Description:</strong><br />Retrieves <strong>filtered users</strong> based on roles (<strong>Auctioneer, Bidder, Admin</strong>).</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit[\n  {\n    \"id\": \"67b3df8a7dea39414602b10c\",\n    \"name\": \"John Doe\",\n    \"role\": \"Bidder\",\n    \"status\": \"Active\"\n  },\n  {\n    \"id\": \"67b3df8a7dea39414602b10d\",\n    \"name\": \"Alice\",\n    \"role\": \"Auctioneer\",\n    \"status\": \"Banned\"\n  }\n]\n\n</code></pre><p>✅ <strong>Success:</strong> Returns filtered users.<br />❌ <strong>Error:</strong> No users found.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"e83c8ea7-be76-4bda-b7fa-6484a3d23e11"},{"name":"GET MONTHLY  REVENUE","id":"bbf5b914-4784-4739-b8d0-38c905c7ccde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"<h2 id=\"🔹-revenue-management\"><strong>🔹 Revenue Management</strong></h2>\n<h3 id=\"💰-get---fetch-monthly-revenue\"><strong>💰 GET - Fetch Monthly Revenue</strong></h3>\n<p>📌 <strong>Endpoint:</strong><br /><code>GET http://localhost:5000/api/v1/superadmin/revenue/monthly</code><br />📌 <strong>Description:</strong><br />Retrieves the <strong>total revenue</strong> earned by the platform from auction commissions <strong>for the current month</strong>.</p>\n<p>📌 <strong>Response Example:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>jsonCopyEdit{\n  \"month\": \"February 2025\",\n  \"totalRevenue\": 25000\n}\n\n</code></pre><p>✅ <strong>Success:</strong> Returns monthly revenue.<br />❌ <strong>Error:</strong> Revenue data not available.</p>\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"bbf5b914-4784-4739-b8d0-38c905c7ccde"}],"id":"1582f6e0-cd51-4e5c-9a2f-715f22d3ac0a","description":"<h3 id=\"🛡️-super-admin-routes--mern-auction-platform-api\"><strong>🛡️ SUPER ADMIN ROUTES – MERN AUCTION PLATFORM API</strong></h3>\n<p>These API endpoints allow the <strong>Super Admin</strong> to manage auctions, users, and payments, ensuring smooth platform operations. 🚀👑</p>\n","_postman_id":"1582f6e0-cd51-4e5c-9a2f-715f22d3ac0a"}]}