Fera Partner Docs
  • Become a Partner
  • 🤝Partner Portal
    • Managed Stores
    • Apps
      • Creating an App
      • Testing App
      • Authenticating App
      • Publishing App
      • Managing App
    • Referrals
      • Referral Link
      • Tracking Referrals
      • Getting Paid
    • Team
  • Partner Badges
    • Works With Fera
    • Trusted Partner Badges
  • 👷Agencies
    • Become Agency Partner
    • Setting up a new store
    • Creating custom storefronts
  • 🧑‍💻Apps & Platforms
    • Become App/Integration Partner
    • SEO Apps
    • Shipping Apps
    • Support Apps
    • Messaging Apps
      • Requesting Reviews
    • Page Builder Apps
    • Partner Resources
  • 🖌️Theme Developers
    • Become Theme Partner
    • Shopify Themes
      • Display Ratings
      • Display Reviews
        • By Customer
    • SEO Schema Support
  • 🎬Content Creators
    • Join Affiliate Program
    • Referral Program
    • Brand Assets
  • 🧑‍💻Developers
    • Visit Developer Center
    • Partner API
      • List Reviews
      • Retrieve Product Ratings
      • Check if Site is Using Fera
      • Other API Endpoints
Powered by GitBook
On this page

Was this helpful?

  1. Developers
  2. Partner API

List Reviews

List reviews of any store by store domain/url.

PreviousPartner APINextRetrieve Product Ratings

Last updated 2 years ago

Was this helpful?

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.

Code Examples

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

Code Examples

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).

🧑‍💻

List All Product Reviews

get

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

Authorizations
Query parameters
domainstringRequired

Domain, URL, public key or Fera ID of the shop/store.

Example: example.myshopify.com
pageinteger · int32 · min: 1Optional

Current page number, if pagination used.

page_sizeinteger · int32 · min: 1Optional

Number of items per page.

limitinteger · int32 · min: 1 · max: 100Optional

Maximum number of items retrieved.

offsetinteger · int32Optional

Starting position of items request query.

product.idstringOptional

Filter by Fera product ID or external product ID.

Example: fpro_123abc
product.idsstringOptional

Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.

Example: fpro_1abc,fpro_2def
customer_idstringOptional

Filter by Fera customer ID or external customer ID.

Example: fcus_12ab
order.idstringOptional

Filter by Fera order ID or external order ID.

Example: ford_123
subjectstring · enumOptional

Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.

Example: productPossible values:
verifiedbooleanOptional

Only show content submitted by verified sources (or unverified sources).

customer.emailstring · emailOptional

Filter by customer email

sort_bystring · enumOptional

Sort (order) the response results by the given attribute.

Add :desc to sort in descending order, or :asc to sort in ascending order.

For example: created_at:desc would get you created_at in descending order.

Possible values:
Responses
200
Successful response
application/json
400
Bad request
application/json
get
GET /v3/partners/stores/products/reviews HTTP/1.1
Host: api.fera.ai
Accept: */*
{
  "data": [
    {
      "id": "fRev_12ab",
      "state": "pending",
      "subject": "product",
      "is_verified": true,
      "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": "2025-05-14T18:51:42.004Z"
      },
      "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": true,
          "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
  }
}

List Product Reviews

get

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

Authorizations
Path parameters
idstringRequired

ID of the product you want to retrieve

Example: fpro_12ab
Query parameters
domainstringRequired

Domain, URL, public key or Fera ID of the shop/store.

Example: example.myshopify.com
pageinteger · int32 · min: 1Optional

Current page number, if pagination used.

page_sizeinteger · int32 · min: 1Optional

Number of items per page.

limitinteger · int32 · min: 1 · max: 100Optional

Maximum number of items retrieved.

offsetinteger · int32Optional

Starting position of items request query.

product.idstringOptional

Filter by Fera product ID or external product ID.

Example: fpro_123abc
product.idsstringOptional

Filter by multiple Fera product IDs or external product IDs. Comma-separated list or array of fields accepted.

Example: fpro_1abc,fpro_2def
customer_idstringOptional

Filter by Fera customer ID or external customer ID.

Example: fcus_12ab
order.idstringOptional

Filter by Fera order ID or external order ID.

Example: ford_123
subjectstring · enumOptional

Filter by what the resource is describing; A specific product, the entire store (ie overall experience) or both (all). Default: both.

Example: productPossible values:
verifiedbooleanOptional

Only show content submitted by verified sources (or unverified sources).

customer.emailstring · emailOptional

Filter by customer email

sort_bystring · enumOptional

Sort (order) the response results by the given attribute.

Add :desc to sort in descending order, or :asc to sort in ascending order.

For example: created_at:desc would get you created_at in descending order.

Possible values:
Responses
200
Successful response
application/json
404
Not found error
application/json
get
GET /v3/partners/stores/products/{id}/reviews HTTP/1.1
Host: api.fera.ai
Accept: */*
{
  "data": [
    {
      "id": "fRev_12ab",
      "state": "pending",
      "subject": "product",
      "is_verified": true,
      "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": "2025-05-14T18:51:42.004Z"
      },
      "counts": {
        "media": 3,
        "photos": 2,
        "videos": 1
      }
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 10,
    "page_count": 3,
    "limit": 10,
    "offset": 0,
    "total_count": 123
  }
}
  • List all Reviews
  • GETList All Product Reviews
  • Code Examples
  • List a Specific Product's Reviews
  • GETList Product Reviews
  • Code Examples