Skip to main content
The sdk.reviews namespace provides methods to fetch store-wide reviews, get review statistics, and submit new reviews. Listing reviews is public; submitting a review requires authentication.

​
Methods

​
reviews.getAll(params?)

Get a paginated list of store reviews, optionally filtered by rating. 
const { data: reviews, pagination } = await sdk.reviews.getAll({
  page: 1,
  per_page: 10,
  rating: 5 // only 5-star reviews
});
Parameters:
FieldTypeDescription
pagenumberPage number
per_pagenumberReviews per page
ratingnumberFilter by rating (1-5)
Returns: { data: Review[]; pagination?: Pagination }

​
reviews.getRecent(limit?)

Get the most recent reviews. 
const recent = await sdk.reviews.getRecent(6);
Parameters:
FieldTypeDefaultDescription
limitnumber6Number of reviews to return
Returns: Review[]

​
reviews.submit(productId, data)

Submit a review for a product. Requires authentication. 
const review = await sdk.reviews.submit(42, {
  rating: 5,
  comment: 'Great product, highly recommended!'
});
Parameters:
FieldTypeDescription
productIdnumberProduct to review
data.ratingnumberRating from 1 to 5
data.commentstringReview text
Returns: Review

​
reviews.getStats()

Get aggregate review statistics for the store. 
const stats = await sdk.reviews.getStats();
Returns: Review statistics object (varies by store configuration).

​
Types

interface Review {
  id: number;
  rating: number;
  comment: string;
  reviewer: {
    id: number;
    name: string;
    email?: string;
  } | null;
  product?: {
    id: number;
    name: string;
    slug: string;
  } | null;
  created_at: string;
}
You can also fetch reviews for a specific product using sdk.products.getReviews(productId). See Products.