README

mhinspeya/module-wishlist

• Main Functionalities
• REST API Endpoints Reference

Main Functionalities

MHinspeya Wishlist enables customer multiple wishlist folder creation, product assignment, product deletion, moving items between lists, and fetching sale items from wishlists via REST API.

REST API Endpoints Reference

All endpoints are configured under /rest/V1/...

1. Get Wishlist Data for Current Customer

• URL: /V1/modehaus-favorites/customwishlist/
• Method: GET
• Auth: Customer Access Token (self)
• Description: Returns all wishlist data for the logged-in customer.
• Response: Array of wishlist items.

2. Get Custom Wishlist Names for Current Customer

• URL: /V1/modehaus-favorites/customwishlistname/
• Method: GET
• Auth: Customer Access Token (self)
• Description: Returns custom wishlist folder names created by the logged-in customer.
• Response: Array of wishlist folder details.

3. Create Custom Wishlist Folder

• URL: /V1/modehaus-favorites/getCreateWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "custom_wishlist": "My Birthday List"
  }
  

• Response:

  [
    {
      "status": 1,
      "message": "Wishlist has been successfully created."
    }
  ]
  

4. Get Wishlist Items

• URL: /V1/modehaus-favorites/getWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: List of wishlist products with prices, brand, colors, sizes, and images.

5. Get New Wishlist Items (Extended Format)

• URL: /V1/modehaus-favorites/getnewWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: List of wishlist products in alternate/extended format.

6. Get Custom Wishlist Folders List

• URL: /V1/modehaus-favorites/customgetWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: Array of custom wishlist folders.

7. Get Products By Wishlist Folder ID

• URL: /V1/modehaus-favorites/getProductsByWishlistId/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "wishlist_id": "123",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: Products assigned to the specific wishlist folder.

8. Get New Products By Wishlist Folder ID (Extended Format)

• URL: /V1/modehaus-favorites/getnewProductsByWishlistId/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "wishlist_id": "123",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: List of products in specific wishlist folder (extended details).

9. Get All Customer Wishlists & Products

• URL: /V1/modehaus-favorites/getAllWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: All wishlists and assigned items.

10. Get All Customer Wishlists & Products (Extended Format)

• URL: /V1/modehaus-favorites/getnewAllWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: All wishlists and items in extended format.

11. Get Sale Items from Wishlist

• URL: /V1/modehaus-favorites/getSaleItems/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: Wishlist items currently on sale/discount.

12. Get Sale Items from Wishlist (Extended Format)

• URL: /V1/modehaus-favorites/getnewSaleItems/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "current_page": 1,
    "page_size": 10
  }
  

• Response: Discounted wishlist products in extended format.

13. Assign Product to Wishlist Folder

• URL: /V1/modehaus-favorites/getAssignedProductWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789",
    "wishlist_id": "123"
  }
  

• Response: Confirmation message of product assignment.

14. Assign Product to Wishlist Folder (Extended Format)

• URL: /V1/modehaus-favorites/getnewAssignedProductWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789",
    "wishlist_id": "123"
  }
  

• Response: Confirmation message of product assignment (extended flow).

15. Remove Product from Wishlist Folder

• URL: /V1/modehaus-favorites/getRemoveProductWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789",
    "wishlist_id": "123"
  }
  

• Response: Product deletion confirmation.

16. Remove Product from Wishlist by ID

• URL: /V1/modehaus-favorites/itemremoveProductWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789"
  }
  

• Response: Confirmation message.

17. Delete Custom Wishlist Folder

• URL: /V1/modehaus-favorites/getRemoveCustomWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "wishlist_id": "123"
  }
  

• Response: Folder deletion confirmation.

18. Remove Product from All Wishlists

• URL: /V1/modehaus-favorites/getRemoveProductAllWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789",
    "wishlist_id": "123"
  }
  

• Response: Deletion confirmation.

19. Reduce/Remove Product from Wishlist

• URL: /V1/modehaus-favorites/getRemoveProductReduceWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789",
    "wishlist_id": "123"
  }
  

• Response: Success response details.

20. Move Product to Different Wishlist Folder

• URL: /V1/modehaus-favorites/moveProductWishlist/
• Method: POST
• Auth: Anonymous
• Payload (JSON):

  {
    "customer_email": "customer@example.com",
    "product_id": "789",
    "wishlistId_current": "123",
    "wishlistId_new": "456"
  }
  

• Response: Confirmation message.