List approved reviews of a product

GET

/cms/product/{id}/reviews

const url = 'https://api.example.com/cms/product/1/reviews?page=1&limit=10';
const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/cms/product/1/reviews?page=1&limit=10' \
  --header 'API-Key: <API-Key>'

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

integer

Query Parameters

page

integer

default: 1

Also accepted as /page/{page}/limit/{limit}

limit

integer

default: 10 >= 1 <= 100

Responses

200

Approved reviews, newest first

application/json

object

rating

number format: float

nullable

rating_count

integer

data

Array<object>

Product Review

A customer review of a product. Only approved reviews are listed publicly.

object

Review ID

integer format: int64

product_id

Product ID

integer format: int64

author_name

Public name of the reviewer (nickname, display name, or first and last name)

string

rating

Rating

integer

>= 1 <= 5

body

Review text (plain text)

string

status

Moderation status

string

Allowed values: pending approved declined

timestamp

Submission date

string format: date-time

last_edited

Last edit by the customer

string format: date-time

nullable

Example

{
  "data": [
    {
      "status": "pending"
    }
  ]
}

400

Invalid limit

404

Product not found or not available