Skip to content
Guides
ES
API reference
stablecatalog:read

List product reviews

GET/v1/catalog/product-reviews

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?null|string
customerId?null|string
status?string
rating?integer
Formatint32

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"
{  "data": [    {      "id": "string",      "productId": "string",      "productName": "string",      "customerId": null,      "orderId": null,      "isVerifiedPurchase": true,      "rating": 0,      "title": null,      "content": "string",      "reviewerName": null,      "reviewerEmail": null,      "status": "pending",      "approvedAt": null,      "approvedBy": null,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}