Skip to content
Last update: December 2, 2024

customerReviews query

This query retrieves customer reviews associated with a specific entity, such as a product or service, allowing filtering and sorting of results.

Arguments

Argument Description
after String A cursor for paginating results, pointing to the position after which to fetch data.
first Int The maximum number of reviews to return.
keyword String A keyword to filter reviews by matching text.
sort String A sorting parameter to order the reviews (e.g., by date or rating).
storeId String! The Id of the store associated with the reviews.
entityId String! The Id of the entity the reviews are linked to (e.g., product ID).
entityType String! The type of entity the reviews are associated with (e.g., "Product").
filter String Additional filters to narrow down the reviews based on specific criteria.

Possible Returns

Possible Return Description
CustomerReviewConnection A paginated list of customer reviews matching the query criteria.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{  
  customerReviews(  
    after: "cursor123",  
    first: 10,  
    keyword: "great",  
    sort: "rating_desc",  
    storeId: "B2B-store",  
    entityId: "product-12345",  
    entityType: "Product",  
    filter: "rating:5"  
  ) {  
    totalCount  
    edges {  
      cursor  
      node {  
        id  
        rating  
        comment  
        author  
      }  
    }  
    pageInfo {  
      hasNextPage  
      hasPreviousPage  
      startCursor  
      endCursor  
    }  
  }  
}  

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{  
  "data": {  
    "customerReviews": {  
      "totalCount": 25,  
      "edges": [  
        {  
          "cursor": "cursor123",  
          "node": {  
            "id": "review1",  
            "rating": 5,  
            "comment": "Excellent product!",  
            "author": "John Doe"  
          }  
        }  
      ],  
      "pageInfo": {  
        "hasNextPage": true,  
        "hasPreviousPage": false,  
        "startCursor": "cursor123",  
        "endCursor": "cursor456"  
      }  
    }  
  }  
}