Skip to main content

Reviews

The Reviews API allows you to request an app review modal overlaid on your embedded app in the Shopify admin. You control when to request a modal, but it will only be displayed to the merchant if certain conditions are met.

Anchor to reviewsReviews

The Reviews API provides a request() method that allows you to request an app review modal.

Anchor to request
request
() => Promise<>
required
Was this section helpful?

Request an app review modal

try {
const result = await shopify.reviews.request();
if (!result.success) {
console.log(`Review modal not displayed. Reason: ${result.code}: ${result.message}`);
}
// if result.success *is* true, then review modal is displayed
} catch (error) {
console.error('Error requesting review:', error);
}

Preview

Anchor to responsesResponse codes and messages

A request to the Reviews API will return one of the following responses:

successcodemessage
truesuccessReview modal displayed
falsemobile-appReview modal not supported on mobile devices
falsealready-reviewedMerchant already reviewed this app
falseannual-limit-reachedReview modal already displayed the maximum number of times within the last 365 days
falsecooldown-periodReview modal already displayed within the last 60 days
falsemerchant-ineligibleMerchant isn't eligible to review this app
falserecently-installedMerchant installed this app for less than 24 hours
falsealreadyOpenReview modal is already open
falseopenInProgressReview modal opening is already in progress
falsecancelledReview modal opening was cancelled
Was this section helpful?

Anchor to rate-limits-restrictionsRate limits and restrictions

A review modal will only be displayed to the merchant if certain conditions are met. Be sure to follow the recommended best practices for requesting reviews.

Rate limits

The Reviews API applies rate limits to ensure a good merchant experience and to prevent abuse. A review modal will only be displayed to a merchant:

  • Once within any 60-day period, and
  • Three times within any 365-day period.

Restrictions

A review modal will never be displayed in these cases:

  • The merchant already reviewed your app.
  • The merchant is on a mobile device.
  • The merchant is ineligible to leave a review.
  • The merchant has installed your app for less than 24 hours
Was this section helpful?

Anchor to best-practicesBest practices for review requests

Because you can make only a limited number of requests for review, make sure to choose the right time:

  • Do request a review at the end of a successful workflow.
  • Don't request a review at any point that interrupts a merchant task.
  • Don't request a review as soon as the merchant opens your app.
  • Don't trigger a request with a button, link, or other call to action. Because the request might be rate-limited and the modal isn't guaranteed to display, your app UI would appear to be broken.
Was this section helpful?

Anchor to testing-the-reviews-apiTesting the Reviews API

You can use your development store to test the Reviews API, which bypasses the rate limits and restrictions. Reviews submitted from development stores are not published on the Shopify App Store.

Was this section helpful?