Skip to content
docs
Guides
ES
CatalogProduct Reviews
catalog:read

List product reviews

GET/v1/catalog/product-reviews

List product reviews. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
productId?string

Identifier of the product.

customerId?string

Identifier of the customer.

status?string

Only items in these statuses.

rating?integer
Formatint32

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/product-reviews" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "productId": "7204558912004325301",      "productName": "Example resource",      "customerId": "7204558912004325301",      "orderId": "7204558912004325301",      "isVerifiedPurchase": false,      "rating": 1,      "title": "Example title",      "content": "example",      "reviewerName": "Example resource",      "reviewerEmail": "andrea@example.com",      "status": "pending",      "approvedAt": "2026-08-01T15:30:00Z",      "approvedBy": "2f40d7e4-3d9c-4ab2-b04e-7a6a132db821",      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}