API Reference
ReviewsCoreLoyaltyHelp CenterAPI keys
  1. Reviews Storefront

Search store reviews

post
https://api-cdn.yotpo.com/v3/storefront/store//reviews

Search or filter storefront reviews for a specific store.

Recipes
🔎
Search and filter reviews
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • No access token is needed. This is a public endpoint served from Yotpo's CDN (api-cdn.yotpo.com).
  • Data is returned with a delay of up to 3 hours, so new or updated reviews can take up to 3 hours to appear.
Path Params
string
required

Store identifier

Query Params
integer
≥ 1
Defaults to 1

Page number, starting from 1. Default: 1.

integer
1 to 150
Defaults to 5

Number of results per page. Default: 5. Values above 150 are capped at 150.

string
enum

Sort order for reviews. Unrecognized values are ignored. smart applies Yotpo's AI-powered Smart Sorting, which puts the most important reviews first. Smart Sorting is part of the Pro and Premium plans.

Allowed:
string
enum

Sort direction: asc or desc. Unrecognized values are ignored.

Allowed:
string

Language code (for example fr) to return translated review content. Unsupported codes return the original text.

Body Params

Filters to apply. All fields are optional; an empty body returns all reviews.

ids
array of integers

Review IDs to return.

ids
scores
array of integers

Star ratings to include, for example [4, 5].

scores
topicNames
array of strings

Topics mentioned in the review. Get available topics from Retrieve product data with include=topics.

topicNames
string

Free-text search across review content.

boolean

Set to true to return only reviews with images or videos.

integer

Maximum number of images returned per review. Does not filter reviews.

string

Two-letter reviewer country code, for example US. Get available countries from Retrieve product data with include=countries.

sortings
array of objects

Sort order. An unsupported sortBy value returns no results.

sortings
crfs
array of objects

Custom question (custom review form) answers to filter by.

crfs
orders
array of objects

Order metadata filters.

orders
metadata
array of objects

Review metadata filters.

metadata
productVariants
object

Variant attributes to filter by, as name/value pairs.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 15 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 15 hours ago

Did this page help you?