Documentation Index
Fetch the complete documentation index at: https://mintlify.com/MarcoAbundio/furniture_api_rest/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Product Reviews API provides several endpoints for searching and filtering reviews based on different criteria.
By Product ID
Endpoint
GET /api/v1/product-reviews/product/{productId}
Path Parameters
The unique identifier of the product
Example Request
curl -X GET "https://api.example.com/api/v1/product-reviews/product/101"
Example Response
[
{
"id": 1,
"productId": 101,
"userId": 501,
"rating": 5,
"comment": "Excellent quality sofa!",
"createdAt": "2024-01-15T10:30:00"
},
{
"id": 3,
"productId": 101,
"userId": 503,
"rating": 5,
"comment": "Beautiful design and great value!",
"createdAt": "2024-01-17T09:15:00"
}
]
By Product ID (Ordered)
Endpoint
GET /api/v1/product-reviews/product/{productId}/ordered
Path Parameters
The unique identifier of the product
Example Request
curl -X GET "https://api.example.com/api/v1/product-reviews/product/101/ordered"
Example Response
[
{
"id": 3,
"productId": 101,
"userId": 503,
"rating": 5,
"comment": "Beautiful design and great value!",
"createdAt": "2024-01-17T09:15:00"
},
{
"id": 1,
"productId": 101,
"userId": 501,
"rating": 5,
"comment": "Excellent quality sofa!",
"createdAt": "2024-01-15T10:30:00"
}
]
Average Rating
Endpoint
GET /api/v1/product-reviews/product/{productId}/average-rating
Path Parameters
The unique identifier of the product
Response
Returns a decimal number representing the average rating.
The calculated average rating for the product
Example Request
curl -X GET "https://api.example.com/api/v1/product-reviews/product/101/average-rating"
Example Response
By Minimum Rating
Endpoint
GET /api/v1/product-reviews/rating/{minRating}
Path Parameters
The minimum rating threshold (inclusive)
Example Request
Get all reviews with 4 stars or higher:
curl -X GET "https://api.example.com/api/v1/product-reviews/rating/4"
Example Response
[
{
"id": 1,
"productId": 101,
"userId": 501,
"rating": 5,
"comment": "Excellent quality sofa!",
"createdAt": "2024-01-15T10:30:00"
},
{
"id": 2,
"productId": 102,
"userId": 502,
"rating": 4,
"comment": "Good dining table.",
"createdAt": "2024-01-16T14:20:00"
},
{
"id": 3,
"productId": 101,
"userId": 503,
"rating": 5,
"comment": "Beautiful design!",
"createdAt": "2024-01-17T09:15:00"
}
]
Endpoint
GET /api/v1/product-reviews/pagination
Query Parameters
The page number to retrieve (zero-based)
The number of reviews per page
Example Request
Get the second page with 20 reviews per page:
curl -X GET "https://api.example.com/api/v1/product-reviews/pagination?page=1&pageSize=20"
Example Response
[
{
"id": 21,
"productId": 105,
"userId": 520,
"rating": 4,
"comment": "Great bookshelf!",
"createdAt": "2024-02-01T08:45:00"
},
{
"id": 22,
"productId": 106,
"userId": 521,
"rating": 5,
"comment": "Love this coffee table.",
"createdAt": "2024-02-02T11:30:00"
}
]
Notes
- Pages are zero-based (first page is
page=0)
- Default page size is 10 reviews
- Returns an array of review objects for the specified page
Status Codes
All search endpoints return:
Successfully retrieved matching product reviews