StartFragment
\nThe LaundryBuddy API Documentation is organized into three main sections:
\n1️⃣ User API 🧑💼
\nHandles user registration, login, profile updates.
\nUsers can place orders, check order status, and submit complaints.
\n2️⃣ Worker API 🛠️
\nWorkers can view all daily orders, track pending/completed orders.
\nCan update order status and notify users via SMS.
\n3️⃣ Admin API 🔧
\nAdmins can create worker accounts by assigning email and password.
\nResponsible for overall system management and worker access control.
\nEndFragment
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39216846","collectionId":"ac49136a-a385-455b-9a68-6ea3b558a623","publishedId":"2sB3dTt8WB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0096FF"},"publishDate":"2025-12-15T13:02:02.000Z"},"item":[{"name":"User","item":[{"name":"1. User Authentication APIs","item":[{"name":"Add new user","id":"297e52ee-149e-4b54-a8e3-5f47bc9a30e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"nagesh\",\r\n \"email\": \"nagesh@gmail.com\",\r\n \"phoneNumber\": \"9898989898\",\r\n \"buildingName\": \"Boys Hostel\",\r\n \"roomNumber\": \"52\",\r\n \"bagNumber\" : \"217\",\r\n \"password\": \"password123\",\r\n \"confirmPassword\": \"password123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://laundry-buddy-yysq.onrender.com/user/signup","description":"Registers a new user by validating input fields, checking for existing users, and securely storing the password.
\n","urlObject":{"protocol":"https","path":["user","signup"],"host":["laundry-buddy-yysq","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"297e52ee-149e-4b54-a8e3-5f47bc9a30e5"},{"name":"Login User","id":"ccc392be-0e78-4d7a-a08e-ec7936cc8fcd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"stakescasino433@gmail.com\",\r\n \"password\": \"pass123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://laundry-buddy-yysq.onrender.com/user/login","urlObject":{"protocol":"https","path":["user","login"],"host":["laundry-buddy-yysq","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccc392be-0e78-4d7a-a08e-ec7936cc8fcd"},{"name":"Forgot-Password","id":"ec2053b8-592f-4aa0-805a-70f872c0c286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\":\"stakescasino433@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://laundry-buddy-yysq.onrender.com/user/forgot-password","urlObject":{"protocol":"https","path":["user","forgot-password"],"host":["laundry-buddy-yysq","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec2053b8-592f-4aa0-805a-70f872c0c286"},{"name":"Reset-Password","id":"652d973d-ae99-47dc-98de-c9db1548dfbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \r\n\r\n \"newPassword\": \"password123\",\r\n \"confirmPassword\": \"password123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://laundry-buddy-yysq.onrender.com/user/reset-password/:token","urlObject":{"protocol":"https","path":["user","reset-password",":token"],"host":["laundry-buddy-yysq","onrender","com"],"query":[],"variable":[{"type":"any","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2N2IyMzM3Yzk3ZWU1YWVlY2ViY2EwZmYiLCJpYXQiOjE3NDAxNjI1OTYsImV4cCI6MTc0MDE2NjE5Nn0.CFiF_629-NItBrXOPPyxvTNYs7sVis914RpaWfj5E-k","key":"token"}]}},"response":[],"_postman_id":"652d973d-ae99-47dc-98de-c9db1548dfbc"},{"name":"Update Password","id":"75d9415b-1fdc-4fb7-ab7f-dbe40abc0df0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2N2IyMzM3Yzk3ZWU1YWVlY2ViY2EwZmYiLCJyb2xlIjoidXNlciIsImlhdCI6MTc0MDE5OTQ3NiwiZXhwIjoxNzQwMjAzMDc2fQ.c1d6cVETY4g4AHWeK6CMTLu91430-6b89rPB5etS-Ko","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"currentPassword\":\"pass@123\",\r\n \"newPassword\":\"password123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://laundry-buddy-yysq.onrender.com/user/update-password","urlObject":{"protocol":"https","path":["user","update-password"],"host":["laundry-buddy-yysq","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75d9415b-1fdc-4fb7-ab7f-dbe40abc0df0"}],"id":"e285f382-c4c0-4ad7-b8b8-8fe16d271b23","description":"https://laundry-buddy-yysq.onrender.com/\n\nPOST /register\n\n{\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phoneNumber\": \"1234567890\",\n \"buildingName\": \"XYZ Apartments\",\n \"roomNumber\": \"101\",\n \"bagNumber\": \"A101\",\n \"password\": \"password123\",\n \"confirmPassword\": \"password123\"\n}\n\n{\n \"success\": true,\n \"message\": \"User registered successfully\",\n \"user\": { \"_id\": \"userId\", \"name\": \"John Doe\", \"email\": \"john@example.com\" }\n}\n\n{\n \"message\": \"User already exists with this email.\"\n}\n\nPOST /login\n\n{\n \"email\": \"john@example.com\",\n \"password\": \"password123\"\n}\n\n{\n \"success\": true,\n \"message\": \"Login successful\",\n \"token\": \"jwt_token\",\n \"name\": \"John Doe\",\n \"userId\": \"userId\",\n \"role\": \"user\"\n}\n\n{\n \"message\": \"Invalid password\"\n}\n\nPOST /forgot-password\n\n{\n \"email\": \"john@example.com\"\n}\n\n{\n \"message\": \"Reset link sent to email\",\n \"link\": \"http://frontend-url.com/reset-password/jwt_token\"\n}\n\n{\n \"message\": \"User not found\"\n}\n\nPOST /reset-password/:token\n\n{\n \"newPassword\": \"newpassword123\",\n \"confirmPassword\": \"newpassword123\"\n}\n\n{\n \"message\": \"Password Updated Successfully\"\n}\n\n{\n \"message\": \"Invalid or expired token\"\n}\n\nPUT /update-password\n\nAuthorization: Bearer jwt_token\n\n{\n \"currentPassword\": \"oldpassword123\",\n \"newPassword\": \"newpassword123\"\n}\n\n{\n \"message\": \"🎉 Password Updated Successfully\"\n}\n\n{\n \"message\": \"Current password is incorrect!\"\n}\n\nEnsure to replace jwt_token with the actual token received after login.
All protected routes require the Authorization: Bearer header.
The reset password link expires in 3 minutes.
\nThe JWT token expires in 1 hour.
\nhttps://laundry-buddy-yysq.onrender.com/\n\nPOST /submit\n\nThis API allows users to submit an order by providing the number of clothes and weight.
\n{\n \"numberOfClothes\": 5,\n \"weight\": 2\n}\n\n{\n \"message\": \"Order submitted successfully\",\n \"order\": {\n \"_id\": \"65abcdef1234567890\",\n \"userId\": \"65xyz1234567890abcd\",\n \"numberOfClothes\": 5,\n \"weight\": 2,\n \"status\": \"Pending\",\n \"createdAt\": \"03/13/2025, 10:30:15 AM\"\n }\n}\n\n{\n \"message\": \"Number of Clothes Are Required\"\n}\n\n{\n \"message\": \"Plz enter the weight\"\n}\n\n{\n \"message\": \"Failed to submit order\",\n \"error\": \"Database connection error\"\n}\n\nGET /summary\n\nThis API retrieves the user's order summary, including total, pending, and completed orders.
\n{\n \"totalOrders\": 10,\n \"lengthOfPending\": 3,\n \"lengthOfComplete\": 7,\n \"order\": [\n {\n \"orderId\": \"65abcdef1234567890\",\n \"numberOfClothes\": 5,\n \"weight\": 2,\n \"status\": \"Pending\",\n \"createdAt\": \"03/13/2025, 10:30:15 AM\"\n },\n {\n \"orderId\": \"65xyz1234567890abcd\",\n \"numberOfClothes\": 3,\n \"weight\": 1.5,\n \"status\": \"Completed\",\n \"createdAt\": \"03/12/2025, 09:15:30 PM\"\n }\n ]\n}\n\n{\n \"message\": \"No order found\"\n}\n\n{\n \"message\": \"Failed to fetch orders\",\n \"error\": \"Database connection issue\"\n}\n\nAll endpoints require authentication using a Bearer token.
\nEnsure proper error handling for missing or incorrect data.
\nDates are formatted in Indian Standard Time (IST).
\nPostman Collection: Import this documentation into Postman to test the API endpoints effectively.
\n","_postman_id":"cf1a3c43-1282-45ea-acf2-ab29210813bb"},{"name":"Complaint Form","item":[{"name":"Submit_Complaint","id":"e9d8efdf-fc9d-4b80-a8f7-60af8541e672","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"67947d062302c1061d974759\", \r\n \"bagNumber\": 1234,\r\n \"typeOfComplaint\": \"Delay\", // The type of complaint\r\n \"description\": \"The laundry was delayed by two days.\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://laundry-buddy-yysq.onrender.com/user/submit-complaint","urlObject":{"protocol":"https","path":["user","submit-complaint"],"host":["laundry-buddy-yysq","onrender","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9d8efdf-fc9d-4b80-a8f7-60af8541e672"}],"id":"a6577867-b9d1-4311-b3e3-d7d3e78815ea","description":"https://laundry-buddy-yysq.onrender.com/\n\nPOST /submit\n\nThis API allows users to submit a complaint by providing their user ID, bag number, type of complaint, and description.
\n{\n \"userId\": \"65abcdef1234567890\",\n \"bagNumber\": \"BAG12345\",\n \"typeOfComplaint\": \"Damaged Clothes\",\n \"description\": \"My clothes were damaged during the wash.\"\n}\n\n{\n \"message\": \"Complaint submitted successfully\",\n \"complaint\": {\n \"_id\": \"65xyz1234567890abcd\",\n \"userId\": \"65abcdef1234567890\",\n \"bagNumber\": \"BAG12345\",\n \"typeOfComplaint\": \"Damaged Clothes\",\n \"description\": \"My clothes were damaged during the wash.\",\n \"userName\": \"John Doe\",\n \"userAddress\": \"Sunset Apartments, Room 101\",\n \"createdAt\": \"03/13/2025, 10:45:00 AM\"\n }\n}\n\n{\n \"message\": \"All fields are required.\"\n}\n\n{\n \"message\": \"User not found.\"\n}\n\n{\n \"message\": \"Failed to submit complaint\",\n \"error\": \"Database connection issue\"\n}\n\nThis endpoint requires authentication via a Bearer token.
\nEnsure that the userId exists in the database before submitting a complaint.
User details (name and address) are automatically added to the complaint.
\nTimestamps are formatted in Indian Standard Time (IST).
\nhttps://laundry-buddy-yysq.onrender.com/\n\nGET /profile\n\nThis API fetches the profile details of the authenticated user.
\n{\n \"_id\": \"65abcdef1234567890\",\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"phoneNumber\": \"9876543210\",\n \"roomNumber\": \"101\",\n \"bagNumber\": \"BAG12345\",\n \"buildingName\": \"Sunset Apartments\",\n \"address\": \"Street 45, City, State, 123456\"\n}\n\n{\n \"message\": \"User not found\"\n}\n\n{\n \"message\": \"Server Error\"\n}\n\nPUT /profile\n\nThis API allows users to update their profile information.
\n{\n \"phoneNumber\": \"9876543210\",\n \"roomNumber\": \"102\",\n \"bagNumber\": \"BAG67890\",\n \"buildingName\": \"Sunrise Towers\",\n \"address\": \"New Street 12, City, State, 654321\"\n}\n\n{\n \"message\": \"Profile Update Successfully\",\n \"user\": {\n \"_id\": \"65abcdef1234567890\",\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"phoneNumber\": \"9876543210\",\n \"roomNumber\": \"102\",\n \"bagNumber\": \"BAG67890\",\n \"buildingName\": \"Sunrise Towers\",\n \"address\": \"New Street 12, City, State, 654321\"\n }\n}\n\n{\n \"message\": \"Phone Number is already in use\"\n}\n\n{\n \"message\": \"User not Found\"\n}\n\n{\n \"message\": \"Internal server error\",\n \"error\": \"Database connection issue\"\n}\n\nAuthentication via a Bearer token is required for both endpoints.
\nThe PUT /profile request allows partial updates (only provided fields will be updated).
Phone numbers must be unique across users.
\nThe GET /profile response includes full user details.
Timestamps are formatted in Indian Standard Time (IST).
\nhttps://laundry-buddy-yysq.onrender.com/\n\nPOST /register → Register a new user.
POST /login → User login.
POST /forgot-password → Send password reset link.
POST /reset-password/:token → Reset password using token.
PUT /update-password → Update password (authenticated).
POST /submit → Submit a new laundry order.
GET /summary → Get order summary (total, pending, completed).
/submit → Submit a complaint regarding laundry service.GET /profile → Fetch user profile details.
PUT /profile → Update user profile details.
All protected routes require Authorization: Bearer token.
Responses include success and error handling messages.
\nTimestamps are formatted in IST.
\nEndpoint: POST /api/admin/workers
Description:
\nThis API allows the admin to create a worker account by assigning an email and password. The password is securely hashed before storing it.
\nMethod: POST
URL Params: None
\nHeaders:
\nContent-Type: application/jsonjsonCopyEdit{ \"email\": \"worker@example.com\", \"password\": \"securepassword\"}
\n✅ Success (201 Created)
\njsonCopyEdit{\n \"message\": \"Worker added successfully\",\n \"worker\": {\n \"_id\": \"65ab3f12e7890d00123abcd\",\n \"email\": \"worker@example.com\",\n \"password\": \"$2a$10$hashedpassword\"\n }\n}\n\n❌ Error Responses
\njsonCopyEdit{\n \"message\": \"Email and password are required.\"\n}\n\njsonCopyEdit{\n \"message\": \"Worker already exists with this email.\"\n}\n\njsonCopyEdit{\n \"message\": \"Error creating worker\",\n \"error\": \"Detailed error message\"\n}\n\nThe Admin Folder in the Postman documentation currently contains one API:
\nAssign Email & Password to Worker (POST /api/admin/workers)
Allows the admin to create worker accounts by assigning an email and password.
\nThe password is securely hashed before storing.
\nReturns a success response with worker details or error messages if the email already exists or if required fields are missing.
\nEndpoint: GET /api/worker/orders
Fetches all orders for the worker, including total orders, pending/completed counts, and user details. Orders are sorted from newest to oldest.
\nHeaders:
\njsonCopyEdit{\n \"Authorization\": \"Bearer <your_token>\"\n}\n\nResponse:
\njsonCopyEdit{\n \"totalOrders\": 15,\n \"pendingOrders\": 5,\n \"completedOrders\": 10,\n \"orders\": [\n {\n \"OrderId\": \"65a123b45cd67890e123f456\",\n \"userName\": \"John Doe\",\n \"phoneNumber\": \"9876543210\",\n \"bagNumber\": \"BG12345\",\n \"numberOfItems\": 10,\n \"status\": \"Pending\",\n \"date\": \"12-03-2025\",\n \"time\": \"10:30 AM\"\n },\n {\n \"OrderId\": \"65b123c45de67890f123g456\",\n \"userName\": \"Jane Smith\",\n \"phoneNumber\": \"8765432109\",\n \"bagNumber\": \"BG67890\",\n \"numberOfItems\": 8,\n \"status\": \"Completed\",\n \"date\": \"10-03-2025\",\n \"time\": \"02:15 PM\"\n }\n ]\n}\n\njsonCopyEdit{\n \"message\": \"No orders found\"\n}\n\njsonCopyEdit{\n \"message\": \"Failed to fetch orders\",\n \"error\": \"Database connection error\"\n}\n\nEndpoint: PUT /api/worker/orders/:orderId
Description:
\nUpdates the order status to Completed and sends an SMS notification to the user.
\nHeaders:
\njsonCopyEdit{\n \"Authorization\": \"Bearer <your_token>\",\n \"Content-Type\": \"application/json\"\n}\n\nRequest Parameters:
\nRequest Body:
\njsonCopyEdit{\n \"phoneNumber\": \"9876543210\",\n \"message\": \"Your laundry order has been completed. Thank you for using our service!\"\n}\n\nResponse:
\njsonCopyEdit{\n \"message\": \"Order status updated to Completed and Notification Send\",\n \"order\": {\n \"_id\": \"65a123b45cd67890e123f456\",\n \"status\": \"Completed\",\n \"smsSent\": true\n }\n}\n\njsonCopyEdit{\n \"message\": \"Order not found\"\n}\n\njsonCopyEdit{\n \"message\": \"An error occurred while updating the order status\",\n \"error\": \"SMS service error or database issue\"\n}\n\nThe Worker folder in the Laundry Management API Documentation contains two main sections:
\nGet All Orders for Worker (GET /worker/orders)
Fetches all orders assigned to workers, sorted by creation date.
\nReturns total orders, pending orders, completed orders, and order details.
\nEach order includes OrderId, userName, phoneNumber, bagNumber, numberOfItems, status, date, and time.
Update Order Status & Send Notification (PUT /worker/orders/:orderId)
Updates the status of an order to Completed.
\nSends an SMS notification to the user using Twilio.
\nRequires orderId in the URL and phoneNumber, message in the request body.