Search store reviews

Search or filter storefront reviews for a specific store.

post/v3/storefront/store/{storeId}/reviews

Request

Base URL
https://api-cdn.yotpo.com
URL
https://api-cdn.yotpo.com/v3/storefront/store/{storeId}/reviews
Auth
none required

Path parameters

storeIdstring required

Store identifier

Query parameters

pageinteger

Page number, starting from 1. Default: 1.

perPageinteger

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

sort'smart' | 'date' | 'badge' | 'images' | 'rating'

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.

direction'asc' | 'desc'

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

langstring

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

Request body

idsinteger[]

Review IDs to return.

scoresinteger[]

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

topicNamesstring[]

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

freeTextSearchstring

Free-text search across review content.

picturedboolean

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

picturesPerReviewinteger

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

countrystring

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

productVariantsobject

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

Response

Changes

No recorded changes to this operation across all 1 revision of this API.