This is a RESTful API for a complete e-commerce system built using Node.js, Express, and MongoDB.
It supports user authentication (with cookie-based sessions), category/product management, shopping cart, orders, coupons, and more.
Registers a new user account.
\nAuthentication: Not required
\nBody Parameters (JSON):
\nname: (string) Required. Full name of the user.
\nemail: (string) Required. Must be unique.
\nphone: (string) Required. Must be unique.
\npassword: (string) Required. The password for the account.
\npasswordConfirm: (string) Required. Must match the password.
\nOn success, the server will set an HTTP-only cookie containing the session token.
\n","urlObject":{"path":["api","v1","auth","signup"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"508dca4c-8ee7-48d7-b915-976599302f28"},{"name":"Log In","event":[{"listen":"test","script":{"id":"e8ff8053-3da4-4395-a70b-615a4a71d10c","exec":[""],"type":"text/javascript","packages":{}}}],"id":"86759c63-6d13-48e2-b9aa-135dd667244a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"momen@example.com\",\r\n \"password\":\"Test@1234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/auth/login","description":"Authenticates the user and starts a new session.
\nAuthentication: Not required
\nBody Parameters (JSON):
\nemail: (string) Required. The user's registered email address.
\npassword: (string) Required. The user's password.
\nIf the credentials are valid, the server sets an HTTP-only cookie containing the session token. This cookie will be used for authenticating subsequent requests.
\nSuccess Response:
Status: 200 OK
Note: No response body is returned. Authentication state is maintained via the HTTP-only cookie.
Logs the user out by clearing the authentication cookie.
\nAuthentication: Required (via cookie)
\nThis endpoint invalidates the current session by removing the token cookie from the client.
\nSuccess Response:
Status: 200 OK
Initiates the password reset process.
\nYou can provide either the email or the phone number. You are not required to provide both.
\nBody Parameters (JSON):
\nemail: (string) Optional. The user's email address.
\nphone: (string) Optional. The user's phone number.
\nNote: At least one of the two fields must be provided.
\nSuccess Response:
Status: 200 OK
A reset code (OTP) will be sent to the provided email or phone.
Verifies the reset code (OTP) sent to the user's email or phone.
\nBody Parameters (JSON):
\nresetOTP: (string) The OTP code received.
\nemail: (string) Optional. The user's email.
\nphone: (string) Optional. The user's phone number.
\nNote: Either email or phone must match what was provided during the \"forgot password\" request.
\nSuccess Response:
Status: 200 OK
The reset token will be verified and approved for password reset.
Resets the user's password after verifying the reset code.
\nBody Parameters (JSON):
\nemail: (string) The user's email address used in the reset request.
\nnewPassword: (string) The new password.
\npasswordConfirm: (string) Confirmation of the new password (must match newPassword).
\nSuccess Response:
Status: 200 OK
The user's password is successfully updated.
Handles user registration, login, logout, and password recovery using email or phone.
Authentication is cookie-based (HTTP-only) to provide secure session management.
This module includes the full password reset workflow and OTP verification.
Manages product categories.
Includes creating, updating, retrieving, and deleting categories.
Supports pagination, filtering, sorting, and field limiting.
Handles subcategories that belong to main categories.
Each subcategory is linked to a category and can be managed separately.
Supports standard CRUD operations with filtering and pagination.
Provides endpoints to manage brand names associated with products.
Brands help organize and classify products by manufacturer or label.
Handles all product-related operations.
Includes creating products with images and variants, updating details, filtering, searching, and more.
Supports dynamic querying for advanced product listing.
Provides endpoints to manage user accounts and profiles.
Includes fetching all users, accessing single user details, updating user data, and deleting accounts.
Admin-level routes are protected.
Allows users to leave reviews and ratings on products.
Each review is linked to a user and a product.
Admin can moderate or remove inappropriate reviews.
Allows users to mark products they are interested in for later.
Wishlist items are stored per user.
Users can add or remove products from their wishlist.
Manages user shipping addresses.
Users can add, update, delete, and select default addresses for their orders.
Each address is associated with the authenticated user.
Manages discount codes that users can apply during checkout.
Admin can create, update, and deactivate coupons.
Validation logic is enforced when applying codes to orders.
Allows authenticated users to add products to their shopping cart, update quantities, and remove items.
Cart operations are tied to the logged-in user session.
Processes user orders based on cart contents.
Includes creating orders, payment status updates, tracking, and viewing order history.
Admin can view and manage all orders.
Provides configuration values that affect global behavior of the system.
\nThis includes:
\nshippingPrice: (number) Flat shipping fee applied to orders.
\nfreeShippingThreshold: (number) The minimum order total required to qualify for free shipping.
\ntaxRate: (number) The tax percentage applied to the total order amount.
\nTypically used by admin to update or retrieve application-wide settings that are referenced in checkout, orders, and invoices.
\n","_postman_id":"bbc0cf64-f8c6-4e97-86e9-6d51d9c70e9d"}]}