---
title: "Search store reviews"
method: POST
path: "/v3/storefront/store/{storeId}/reviews"
---

# Search store reviews

`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

Search or filter storefront reviews for a specific store.

## Path parameters

- `storeId` string, required

## Query parameters

- `page` integer
- `perPage` integer
- `sort` 'smart' | 'date' | 'badge' | 'images' | 'rating'
- `direction` 'asc' | 'desc'
- `lang` string

## Request body

- object: Filters to apply. All fields are optional; an empty body returns all reviews.
  - `ids` integer[]: Review IDs to return.
  - `scores` integer[]: Star ratings to include, for example `[4, 5]`.
  - `topicNames` string[]: Topics mentioned in the review. Get available topics from Retrieve product data with `include=topics`.
  - `freeTextSearch` string: Free-text search across review content.
  - `pictured` boolean: Set to `true` to return only reviews with images or videos.
  - `picturesPerReview` integer: Maximum number of images returned per review. Does not filter reviews.
  - `country` string: Two-letter reviewer country code, for example `US`. Get available countries from Retrieve product data with `include=countries`.
  - `sortings` object[]: Sort order. An unsupported `sortBy` value returns no results.
    - `sortBy` string: Field to sort by, for example `date`.
    - `ascending` boolean: `true` for ascending order.
  - `crfs` object[]: Custom question (custom review form) answers to filter by.
    - `questionId` integer: Custom question ID.
    - `answers` string[]: Answer values to match.
    - `displayAnswers` string[]: Answer labels as displayed.
  - `orders` object[]: Order metadata filters.
    - `questionId` string: Order question ID.
    - `subType` string: Question subtype.
    - `question` string: Question text.
    - `answers` string[]: Answer values to match.
  - `metadata` object[]: Review metadata filters.
    - `fieldType` string: Metadata field type.
    - `question` string: Metadata field name.
    - `answers` string[]: Values to match.
  - `productVariants` object: Variant attributes to filter by, as name/value pairs.

## Response `200`

OK

- object
  - `status` object: Response status.
    - `code` integer: HTTP status code.
    - `message` string: Status message.
  - `response` object: Response payload.
    - `foundFilteredReviews` boolean: `true` when the filters matched reviews; `null` when nothing matched.
    - `pagination` object: Pagination details.
      - `page` integer: Current page number.
      - `perPage` integer: Results per page.
      - `total` integer: Total number of results.
    - `reviews` object[]: Reviews on this page.
      - `id` integer
      - `score` integer: Star rating, 1 to 5.
      - `content` string: Review text.
      - `title` string: Review title.
      - `createdAt` string, date-time: When the review was created (ISO 8601).
      - `sentiment` number
      - `videosData` unknown
      - `imagesData` unknown
      - `comment` unknown
      - `productId` integer: Product ID (domain key) in your store.
      - `user` object
        - `userId` integer
        - `socialImage` unknown
        - `userType` string
        - `isSocialConnected` integer
        - `displayName` string
      - `isShop` boolean
      - `fieldsHighlights` unknown
      - `language` string
      - `translatedLanguage` unknown
    - `products` object[]
      - `id` integer
      - `domainKey` string
      - `name` string
      - `socialLinks` object
        - `linkedin` string
        - `facebook` string
        - `twitter` string
        - `googleOauth2` string
      - `embeddedWidgetLink` string
      - `testimonialsProductLink` string
      - `productLink` string
      - `imageUrl` string
      - `productTags` unknown

## Other responses

- `404`: Unknown store ID. The body is the plain string `Account not found`. An unknown product ID returns `200` with no data instead.

---

[API](https://skmtc.dev/yotpo/apis/ugc-storefront-api.md) - [All operations](https://skmtc.dev/yotpo/apis/ugc-storefront-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yotpo/apis/ugc-storefront-api/revisions/09189726cf4b?raw)