You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
getProductReviews
Method fetching reviews of a single product from SAP Commerce Cloud.
This method sends a GET request to the getProductReviews endpoint of the Alokai Middleware. In turn, it receives data from the getProductReviews endpoint exposed by the SAP OCC API Products Controller.
Signature
export declare function getProductReviews<Res extends ReviewList = ReviewList,
Props extends GetProductReviewsProps = GetProductReviewsProps>(
props: Props,
options?: MethodOptions
): Promise<Res>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
props | Required | Props | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
options | Optional | MethodOptions | Options that can be passed to additionally configure the request or customize the logic in a plugin. |
Referenced Types
Examples
Fetching a product by its productCode.
import { sdk } from '~/sdk';
const product = await sdk.commerce.getProductReviews({ productCode: '1992695' });Using the method the way it will be possible to cache the response.
import { sdk } from '~/sdk';
const product = await sdk.commerce.getProductReviews({ productCode: '1992695', lang: 'en', currency: 'GBP' });Fetching a product by its productCode and selecting response fields.
import { sdk } from '~/sdk';
const product = await sdk.commerce.getProductReviews({ productCode: '1992695', fields: 'BASIC' });Fetching a product by its productCode and setting the maxCount of reviews.
import { sdk } from '~/sdk';
const product = await sdk.commerce.getProductReviews({ productCode: '1992695', maxCount: 4 });