Skip to content

List a customer's reviews

GET
/stores/{storeRef}/customers/{customerId}/reviews
curl --request GET \
--url 'https://apibase.ecomweb.app/api/v1/stores/example/customers/1/reviews?limit=50&offset=0' \
--header 'x-api-key: <x-api-key>'

Returns the product reviews the customer wrote and the review invitations the store sent them. Both are matched by email, so a customer without an email gets two empty lists. Use limit to cap how many of each are returned.

Required scopes: read:customers

customerId
required
integer

The customer ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

limit
number
default: 50 >= 1 <= 100

Maximum number of items to return, 1 to 100.

offset
number
0

Number of items to skip.

status
string

Filter orders by order_status

before
string

Opaque cursor from a previous response’s next_before

Media typeapplication/json
object
reviews
required

Reviews written by the customer. Empty for a customer without an email.

Array<object>
object
variant_id

ID of the reviewed variant, or null.

number
nullable
variant_name

Name of the reviewed variant, or null.

string
nullable
order_id

ID of the order the review is about, or null.

number
nullable
order_number

Number of the order the review is about, or null.

number
nullable
user_id

ID of the customer account that wrote the review, or null.

string
nullable
reviewer_avatar

URL of the reviewer’s avatar, or null.

string
nullable
title

Review title, or null.

string
nullable
media
required

Photos or other media attached to the review: a list of objects such as { "url": "https://...", "type": "image" }.

Array<object>
object
key
additional properties
any
status
required

Moderation status: PENDING, APPROVED, REJECTED or HIDDEN. Only APPROVED reviews are shown to shoppers.

string
Allowed values: PENDING APPROVED REJECTED HIDDEN
moderation_notes

Internal moderation notes, or null.

string
nullable
approved_by

ID of the user who approved the review, or null.

string
nullable
approved_at

When the review was approved, as an ISO 8601 timestamp, or null.

string
nullable
rejected_reason

Why the review was rejected, or null.

string
nullable
display_order

Position used when sorting by display_order, or null.

number
nullable
external_review_id

The review’s ID on the platform it was imported from, or null.

string
nullable
review_date

The date shown for the review, as an ISO 8601 timestamp, or null. Imported reviews keep their original date here.

string
nullable
deleted_at

When the review was deleted. Always null on reviews you can read.

string
nullable
review_replies

The review’s replies. Present only when replies are requested with include_replies on the list route.

Array<object>
object
deleted_at

When the reply was deleted. Always null on replies you can read.

string
nullable
id
required

Reply ID.

string
review_id
required

ID of the review the reply answers.

string
content
required

Reply text.

string
author_id
required

ID of the user who wrote the reply.

string
author_name
required

Name shown as the reply’s author.

string
is_visible
required

Whether the reply is shown to shoppers.

boolean
created_at
required

When the reply was created, as an ISO 8601 timestamp.

string
updated_at
required

When the reply was last updated, as an ISO 8601 timestamp.

string
id
required

Review ID.

string
product_id
required

ID of the reviewed product.

number
product_name
required

Name of the reviewed product when the review was written.

string
reviewer_name
required

Reviewer’s name.

string
reviewer_email
required

Reviewer’s email.

string
is_verified_buyer
required

Whether the reviewer bought the product from the store.

boolean
rating
required

Star rating, 1 to 5.

number
content
required

Review text.

string
pros
required

What the reviewer liked.

Array<string>
cons
required

What the reviewer disliked.

Array<string>
is_featured
required

Whether the review is featured.

boolean
is_pinned
required

Whether the review is pinned to the top of the list.

boolean
created_at
required

When the review was created, as an ISO 8601 timestamp.

string
updated_at
required

When the review was last updated, as an ISO 8601 timestamp.

string
invitations
required

Invitations sent to the customer. Empty for a customer without an email.

Array<object>
object
id
required

Invitation ID.

number
order_number
required

Number of the order the invitation is for.

number
product_name
required

Name of the product to review.

string
status
required

Invitation state.

string
sent_at
required

When the invitation was sent, or null.

string
nullable
opened_at
required

When the customer opened it, or null.

string
nullable
submitted_at
required

When the customer submitted a review from it, or null.

string
nullable

Example

{
"reviews": [
{
"status": "PENDING"
}
]
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}