You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getReview
Endpoint for fetching paginated reviews for the provided product. By default, it uses the getReviewDefaultQuery GraphQL query
Signature
export declare function getReview(
context: SetupContext,
params: GetReviewParams,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<GetReviewResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Required | GetReviewParams | Product information and pagination options |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
Reviews data