Base URL: https://api.ecommerce.com

Versioning: All endpoints are currently under /api/v1/. There is no v2 yet, and all new features are added to v1.

Authentication: After successful login via POST /api/v1/Auth/login, a session_token is returned in the response body. This token MUST be included in subsequent requests as a custom header X-Session-Token for authentication.

Endpoints:

1. User Management
   • GET /api/v1/getUserById/{userId}
     • Description: Retrieves details of a specific user.
     • Example Response (200 OK):

       
       1{
       2    "id": "user123",
       3    "userName": "john.doe",
       4    "emailAddress": "john.doe@example.com"
       5}
       

   • PUT /api/v1/users/create
     • Description: Creates a new user account. The client should not provide an ID in the URL.
     • Example Request Body:

       
       1{
       2    "username": "jane.doe",
       3    "password": "secure_password",
       4    "email": "jane.doe@example.com"
       5}
       

     • Example Response (201 Created):

       
       1{
       2    "message": "User created successfully",
       3    "userId": "user456"
       4}
       

   • GET /api/v1/users/resetPassword?email={emailAddress}
     • Description: Initiates a password reset process by sending a reset email to the provided address.
     • Example Response (200 OK):

       
       1{
       2    "message": "Password reset email sent. Please check your inbox."
       3}
       

2. Product Management
   • GET /api/v1/getAllCategories
     • Description: Fetches all product categories.
     • Example Response (200 OK): (Content-Type: text/plain)

       Electronics, Books, HomeGoods
       

   • POST /api/v1/products/{id}/updateStock
     • Description: Updates the stock quantity for a specific product. This operation can be called multiple times with the same input to achieve the same result (e.g., setting stock to 100).
     • Example Request Body:

       
       1{
       2    "quantity": 95,
       3    "warehouseId": "WH001"
       4}
       

     • Example Response (200 OK):

       
       1{
       2    "productId": "prodABC",
       3    "newStock": 95
       4}
       

   • DELETE /api/v1/products/deleteProduct/{productId}
     • Description: Deletes a product from the catalog.
     • Example Response (204 No Content): (No body)

3. Order Management
   • GET /api/v1/orders/cancel?orderId={id}
     • Description: Cancels an existing order by its ID. This action changes the state of the order.
     • Example Response (200 OK):

       
       1{
       2    "status": "Order Cancelled",
       3    "orderId": "order789"
       4}
       

   • POST /api/v1/orders/placeOrder
     • Description: Places a new order.
     • Example Request Body:

       
       1{
       2    "userId": "user123",
       3    "items": [
       4        {"productId": "prodXYZ", "quantity": 1}
       5    ]
       6}
       

     • **Example Response (201 Created):)

       
       1{
       2    "message": "Order placed successfully",
       3    "orderId": "order789",
       4    "totalAmount": 99.99
       5}
       

4. Shopping Cart
   • DELETE /api/v1/removeItemFromCart/{itemId}
     • Description: Removes a specific item from the authenticated user's cart. This relies on the X-Session-Token header to identify the user's cart.
     • **Example Response (200 OK):)

       
       1{
       2    "message": "Item removed from cart"
       3}