createReviewRequest( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a new review request.

A review request is a request sent to a customer to solicit a review for a specific order or specific items. This method requires either the order.id or items.catalogItemId.

You must pass either an order ID or at least 1 item ID:

  • Order ID only:: The review request automatically includes the 5 most expensive items from the order.
  • Item IDs only: The review request includes only the specified items.
  • Order ID and item IDs: The review request includes the specified items from the given order.
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Review Requests
Learn more about app permissions.
Method Declaration
Copy
function createReviewRequest(
  reviewRequest: ReviewRequest,
): Promise<ReviewRequest>;
Method Parameters
reviewRequestReviewRequestRequired

Review request to create.

Returns
Return Type:Promise<ReviewRequest>
JavaScript
import { reviewRequests } from "@wix/reviews";

async function createReviewRequest(reviewRequest) {
  const response = await reviewRequests.createReviewRequest(reviewRequest);
}
Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?