createProductReview
Create product review
Signature
declare function createProductReview(
context: Context,
input: {
recaptchaToken?: string;
} & CreateProductReviewInput,
customQuery?: CustomQuery,
customHeaders?: CustomHeaders
): Promise<FetchResult<CreateProductReviewMutation>>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | Context | |
input | Required | { recaptchaToken?: string; } & CreateProductReviewInput | |
customQuery | Optional | CustomQuery | |
customHeaders | Optional | CustomHeaders |
Referenced Types
- Context
- CreateProductReviewInput
- CustomQuery
- CustomHeaders
FetchResultCreateProductReviewMutation
Examples
Simple usage:
import { sdk } from '~/sdk.config.ts';
// create review data structure
const review = {
sku: 'some-sku',
nickname: 'john.doe',
summary: 'awesome thing, whatever it is!',
text: 'this is a test review',
ratings: [{
id: 'NA==', // base64 encoded id
value_id: 'MjA=' // base64 encoded value_id
}]
};
const result = await sdk.magento.createProductReview(review);
// result will contain the created review and summary data