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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Review Requests
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
reviewRequestReviewRequestRequired

Review request to create.

Returns
Return Type:Promise<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?