Wishlist API

This documentation provides comprehensive details for the Wishlist API endpoints. The API supports adding products to wishlist, retrieving user's wishlist items, checking product status, and removing products from wishlist. Wishlist functionality is user-specific and requires authentication to access personal wishlist data.

Base URL: http://localhost:8080

Authentication

All Wishlist endpoints require Bearer token authentication. Include the access token in the Authorization header:

Authorization: Bearer <your_access_token>

Wishlist Endpoints

Method	Endpoint	Description	Authentication Required
POST	/wishlist	Add a product to wishlist	Yes
GET	/wishlist	Retrieve user's wishlist items (Paginated)	Yes
GET	/wishlist/check	Check if a product is in wishlist	Yes
DELETE	/wishlist/remove	Remove a product from wishlist	Yes

---

Endpoint Details

1. Add Product to Wishlist

POST /wishlist

Add a product to the authenticated user's wishlist.

Request Body

Parameter	Type	Required	Description
productId	string	Yes	UUID of the product to add to wishlist

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	application/json	Yes

Example Request

curl -X 'POST' \
  'http://localhost:8080/wishlist' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
  "productId": "5b24d429-c981-47c8-9318-f4d61dd2c1a4"
}'

Example Response

{
  "isSuccess": true,
  "statusCode": {
    "value": 200,
    "description": "OK"
  },
  "data": {
    "product": {
      "id": "5b24d429-c981-47c8-9318-f4d61dd2c1a4",
      "categoryId": "58f5c085-d04a-47de-beab-1d476b6ce432",
      "name": "Polo T Shirt",
      // ... product details
    }
  }
}

---

2. Get Wishlist Items

GET /wishlist

Retrieve all products in the authenticated user's wishlist with pagination.

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Items per page (default: 10)

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'GET' \
  'http://localhost:8080/wishlist?page=1&limit=10' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
  "isSuccess": true,
  "statusCode": {
    "value": 200,
    "description": "OK"
  },
  "data": [
    {
      "id": "5b24d429-c981-47c8-9318-f4d61dd2c1a4",
      "name": "Polo T Shirt",
      // ... product details
    }
  ]
}

---

3. Check Product in Wishlist

GET /wishlist/check

Check if a specific product exists in the user's wishlist.

Query Parameters

Parameter	Type	Required	Description
productId	string	Yes	UUID of the product to check

Example Request

curl -X 'GET' \
  'http://localhost:8080/wishlist/check?productId=5b24d429-c981-47c8-9318-f4d61dd2c1a4' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>'

Example Response

{
  "isSuccess": true,
  "statusCode": {
    "value": 200,
    "description": "OK"
  },
  "data": true
}

---

4. Remove Product from Wishlist

DELETE /wishlist/remove

Remove a specific product from the authenticated user's wishlist.

Query Parameters

Parameter	Type	Required	Description
productId	string	Yes	UUID of the product to remove from wishlist

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'DELETE' \
  'http://localhost:8080/wishlist/remove?productId=5b24d429-c981-47c8-9318-f4d61dd2c1a4' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
  "isSuccess": true,
  "statusCode": {
    "value": 200,
    "description": "OK"
  },
  "data": {
      "id": "5b24d429-c981-47c8-9318-f4d61dd2c1a4",
      "name": "Polo T Shirt",
      // ... product details
  }
}

---

Response Format

All API responses follow a consistent format:

{
  "isSuccess": boolean,
  "statusCode": {
    "value": number,
    "description": string
  },
  "data": any
}

Response Fields

Field	Type	Description
isSuccess	boolean	Indicates if the operation was successful
statusCode.value	number	HTTP status code
statusCode.description	string	HTTP status description
data	any	Response data (varies by endpoint)

---

Error Handling

The API returns appropriate HTTP status codes and error messages:

Status Code	Description
200	OK - Request successful
400	Bad Request - Invalid product ID or missing required fields
401	Unauthorized - Invalid or missing authentication
403	Forbidden - Insufficient privileges
404	Not Found - Product not found or not in wishlist
409	Conflict - Product already exists in wishlist (on Add)
500	Internal Server Error - Server error