List Reviews

List reviews of any store by store domain/url.

As a partner you have access to list any reviews that a Fera store is using.

Normally this information is available via our public api (Fera.js) but that requires you to know the store's public key.

This API returns data in the same format as the public API (Fera.js) but only requires the store domain/url.

List all Reviews

This list of reviews includes all reviews for all products, plus store (business) reviews that aren't specific to a product.

List All Product Reviews

Retrieve a list of product reviews. That is, retrieve all reviews that are about products.

GEThttps://api.fera.ai/v3/partners/stores/products/reviews

Authorization

apiKey

Query parameters

Response

200400

Successful response

Body

application/json

dataarray of Review (object)

metalistMetaParam (object)

Pagination and count information about the list of objects retrieved.

Request

JavaScriptCurlPython

const response = await fetch('https://api.fera.ai/v3/partners/stores/products/reviews?domain=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "data": [
    {
      "id": "fRev_12ab",
      "state": "pending",
      "subject": "product",
      "is_verified": false,
      "is_test": false,
      "external_product_id": "12345678",
      "product_id": "fpro_12ab",
      "external_customer_id": "12345678",
      "customer_id": "fcus_12ab",
      "created_at": "2022-11-06T19:38:13.116Z",
      "updated_at": "2022-11-06T19:38:13.117Z",
      "rating": 4,
      "heading": "This is a great product!",
      "body": "This is a great product! I love it!",
      "store_reply": {
        "body": "We're sorry that it took so long for your product to arrive but we are delighted that you loved the product we shipped you and recommend it to others! Thanks for being a great customer!",
        "created_at": "2024-11-21T06:23:54.611Z"
      },
      "counts": {
        "media": 3,
        "photos": 2,
        "videos": 1
      },
      "product": {
        "id": "fPro_12ab",
        "external_id": "12345678",
        "name": "Red Sneakers",
        "sku": "RS-123",
        "url": "https://www.example.com/red-sneakers",
        "thumbnail_url": "https://cdn.fera.ai/img/sunglasses.png",
        "price": 10,
        "rating": 5,
        "counts": {
          "reviews": 5,
          "media": 3,
          "photos": 2,
          "videos": 1
        },
        "created_at": "2022-11-06T19:38:14.101Z",
        "updated_at": "2022-11-06T19:38:14.101Z"
      },
      "customer": {
        "id": "fSer_12ab",
        "display_name": "George B.",
        "display_location": "Austin, TX",
        "avatar_url": "https://cdn.fera.ai/img/shoppers/placeholder.png",
        "average_rating": 4.5,
        "rating": 0,
        "counts": {
          "reviews": 5,
          "media": 5
        }
      },
      "media": [
        {
          "id": "fMed_12ab",
          "state": "pending",
          "subject": "product",
          "is_verified": false,
          "is_test": false,
          "external_product_id": "12345678",
          "product_id": "fpro_12ab",
          "external_customer_id": "12345678",
          "customer_id": "fcus_12ab",
          "created_at": "2022-11-06T19:38:13.669Z",
          "updated_at": "2022-11-06T19:38:13.669Z",
          "type": "photo",
          "review_id": "frev_12ab",
          "url": "https://cdn.fera.ai/img/sunglasses.png",
          "thumbnail_url": "https://cdn.fera.ai/img/sunglasses.png?size=thumbnail",
          "caption": "Here's how my product purchase looked when I opened the box I received."
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 10,
    "page_count": 3,
    "limit": 10,
    "offset": 0,
    "total_count": 123
  }
}

Code Examples

CURL

curl --request GET \
     --url https://api.fera.ai/v3/partners/stores/products/reviews?domain=example.com \
     --header 'Api-Key: YOUR_PARTNER_API_KEY'
# See JSON response examples above

List a Specific Product's Reviews

List Product Reviews

Retrieve a list of reviews that belong to a product, if any.

GEThttps://api.fera.ai/v3/partners/stores/products/{id}/reviews

Authorization

apiKey

Path parameters

id*string

ID of the product you want to retrieve

Example: "fpro_12ab"

Query parameters

Response

200404

Successful response

Body

application/json

dataarray of ReviewWithoutNesting (object)

metalistMetaParam (object)

Pagination and count information about the list of objects retrieved.

Request

JavaScriptCurlPython

const response = await fetch('https://api.fera.ai/v3/partners/stores/products/{id}/reviews?domain=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "data": [
    {
      "id": "fRev_12ab",
      "state": "pending",
      "subject": "product",
      "is_verified": false,
      "is_test": false,
      "external_product_id": "12345678",
      "product_id": "fpro_12ab",
      "external_customer_id": "12345678",
      "customer_id": "fcus_12ab",
      "created_at": "2022-11-06T19:38:13.663Z",
      "updated_at": "2022-11-06T19:38:13.664Z",
      "rating": 4,
      "heading": "This is a great product!",
      "body": "This is a great product! I love it!",
      "store_reply": {
        "body": "We're sorry that it took so long for your product to arrive but we are delighted that you loved the product we shipped you and recommend it to others! Thanks for being a great customer!",
        "created_at": "2024-11-21T06:23:54.611Z"
      },
      "counts": {
        "media": 3,
        "photos": 2,
        "videos": 1
      }
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 10,
    "page_count": 3,
    "limit": 10,
    "offset": 0,
    "total_count": 123
  }
}

Code Examples

CURL

curl --request GET \
     --url https://api.fera.ai/v3/partners/stores/products/123456789/reviews?domain=example.com \
     --header 'Api-Key: YOUR_PARTNER_API_KEY'
# See JSON response examples above

If the store does not exist in Fera then you will receive a Bad Request response (400 status code).