Skip to main content

📄 Pagination in Reviews

This guide explains how to use pagination when listing reviews with the Alphabite Reviews Plugin. Pagination is crucial for handling large datasets efficiently, allowing you to retrieve reviews in manageable chunks.

✅ Prerequisites​

  • A Medusa backend with the Reviews plugin installed and configured.
  • Existing reviews in your system.

🔨 Step-by-Step Implementation​

The list and listProductReviews endpoints support pagination parameters: limit and offset.

  • limit: Specifies the maximum number of items to retrieve in a single request.
  • offset: Specifies the number of items to skip from the beginning of the result set.

1. Basic Pagination Example​

Here's how to retrieve reviews using limit and offset.

// Retrieve the first 10 reviews
const firstPage = await sdk.alphabite.reviews.list({
  limit: 10,
  offset: 0,
});
console.log("First 10 reviews:", firstPage.reviews);

// Retrieve the next 10 reviews (skipping the first 10)
const secondPage = await sdk.alphabite.reviews.list({
  limit: 10,
  offset: 10,
});
console.log("Next 10 reviews:", secondPage.reviews);

2. Understanding the Response​

The paginated response includes metadata to help you navigate through the results:

{
  "reviews": [
    // ... array of review objects
  ],
  "count": 50, // Total number of reviews available
  "limit": 10, // Number of reviews returned in this request
  "offset": 0, // Number of reviews skipped
  "totalPages": 5, // Total number of pages
  "currentPage": 1, // Current page number (1-based)
  "nextPage": 2, // Next page number (if available)
  "prevPage": null // Previous page number (if available)
}

You can use count, limit, and offset to calculate the total number of pages and determine if there are more results to fetch.

API Reference

Learn more about our Medusa SDK Wrapper Alphabite Medusa SDK Wrapper 🔗

You can view the full endpoint documentation for:

📝 Notes​

  • Always specify limit and offset for efficient data retrieval, especially when dealing with a large number of reviews.
  • The order parameter can be used in conjunction with pagination to sort results (e.g., -created_at for newest first).

🔗 Related​