Alokai

createProductReview

Create product review

Signature

declare function createProductReview(
	context: Context,
	input: {
  recaptchaToken?: string;
} & CreateProductReviewInput,
	customQuery?: CustomQuery,
	customHeaders?: CustomHeaders
): Promise<FetchResult<CreateProductReviewMutation>>;

Parameters

NameRequiredTypeDescription
contextRequiredContext
inputRequired{ recaptchaToken?: string; } & CreateProductReviewInput
customQueryOptionalCustomQuery
customHeadersOptionalCustomHeaders

Referenced Types

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

On this page