The Review Requests API allows you to create and manage requests that can be sent to customers, asking them to provide reviews for a specific order or specific items.
With the Review Requests API, you can:
It is important to note the following points before starting to code:
"stores" namespace.This article presents a possible use case and corresponding sample flow that you can support. This can be a helpful jumping off point as you plan your implementation.
You can retrieve a list of all review requests scheduled to be sent tomorrow. This enables you to preview and manage these requests before they are sent.
To retrieve tomorrow's review requests:
sendDate of tomorrow.The following table shows field support for filters and sorting for review request properties:
| Field | Supported Filters | Sortable |
|---|---|---|
automationActivationId | $eq, $ne, $in, $nin, $exists | No |
communicationChannel | $eq, $ne, $in, $nin | No |
createdDate | $eq, $ne, $lt, $lte, $gt, $gte $in, $nin | Yes |
id | $eq, $ne, $in, $nin | No |
items.catalogItemId | $eq, $ne, $in, $nin, $hasSome, $hasAll | No |
items.reviewId | $eq, $ne, $in, $nin, $hasSome, $hasAll, isEmpty | No |
namespace | $eq, $ne, $in, $nin | No |
order.id | $eq, $ne, $in, $nin, $exists | No |
recipient.contactId | $eq, $ne, $in, $nin | No |
requestedBy.appId | $eq, $ne, $in, $nin | No |
requestedBy.identityType | $eq, $ne, $in, $nin | No |
requestedBy.wixUserId | $eq, $ne, $in, $nin | No |
sendDate | $eq, $ne, $lt, $lte, $gt, $gte $in, $nin | Yes |
status | $eq, $ne, $in, $nin | Yes |
A review request is a request sent to a customer to solicit a review for a specific order or specific items.
Review request ID.
Revision number, which increments by 1 each time the review request is updated. To prevent conflicting changes, the current revision must be passed when updating the review request.
Ignored when creating a review request.
Date and time the review request was created.
Date and time the review request was last updated.
Date and time the review request was, or will be, sent. This field is only informational and does not trigger a send action.
Name of the Wix app whose catalog the items being reviewed belong to.
Supported values:
storesCurrently, only Wix Stores is fully integrated with the Wix Reviews app.
Order that a review is requested for.
Items that a review is requested for.
Customer to send a review request to.
Communication channel for sending the review request.
Review request status.
ID of the automation action that triggered the review request to be created.
This field is only used if a review request was created by the automation included with Wix Reviews. Also see the Automations API for more information.
ID of the user or app that generated the review request.
Info if status is SENT.
Info if status is FAILED.
{
"id": "15f470a4-a960-43bb-b1ed-886e1050efcd",
"revision": "1",
"createdDate": "2024-08-21T06:43:38.240Z",
"updatedDate": "2024-08-21T07:22:40.086Z",
"sendDate": "2024-08-21T06:44:38.231Z",
"namespace": "stores",
"order": {
"id": "6f4770fc-b8ee-4bf2-9977-d048a7f27987",
"number": "10049"
},
"items": [
{
"catalogItemId": "cd59cd36-b6d2-2cf3-9d48-81793a7bdbbd",
"reviewId": "754df3c0-0cf3-4df5-b988-fc5a0eed0eb6"
}
],
"recipient": {
"contactId": "8d141741-5caf-455b-9775-64b64119fa9a"
},
"communicationChannel": "EMAIL",
"status": "SCHEDULED",
"automationActivationId": "73fff183-acf3-4770-b527-f65f9f10d5f6",
"requestedBy": {
"wixUserId": "28073e47-8038-4dd3-ad3c-343602992889",
"identityType": "WIX_USER"
}
}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:
You can only call this method when authenticated as a Wix app or Wix user identity.
Review request to create.
Created review request.
curl -X POST \
'https://www.wixapis.com/reviews/v2/review-requests' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: <AUTH>' \
-d '{
"reviewRequest":
{
"sendDate": "2024-08-21T06:44:38.231Z",
"namespace": "stores",
"order": {
"id": "6f4770fc-b8ee-4bf2-9977-d048a7f27987",
"number": "10049"
},
"items": [
{
"catalogItemId": "cd59cd36-b6d2-2cf3-9d48-81793a7bdbbd",
}
],
"recipient": {
"contactId": "8d141741-5caf-455b-9775-64b64119fa9a"
},
"communicationChannel": "EMAIL",
"automationActivationId": "73fff183-acf3-4770-b527-f65f9f10d5f6",
}
}'{
"reviewRequest": {
"id": "15f470a4-a960-43bb-b1ed-886e1050efcd",
"revision": "1",
"createdDate": "2024-08-21T06:43:38.240Z",
"updatedDate": "2024-08-21T07:22:40.086Z",
"sendDate": "2024-08-21T06:44:38.231Z",
"namespace": "stores",
"order": {
"id": "6f4770fc-b8ee-4bf2-9977-d048a7f27987",
"number": "10049"
},
"items": [
{
"catalogItemId": "cd59cd36-b6d2-2cf3-9d48-81793a7bdbbd"
}
],
"recipient": {
"contactId": "8d141741-5caf-455b-9775-64b64119fa9a"
},
"communicationChannel": "EMAIL",
"status": "SCHEDULED",
"automationActivationId": "73fff183-acf3-4770-b527-f65f9f10d5f6",
"requestedBy": {
"wixUserId": "28073e47-8038-4dd3-ad3c-343602992889",
"identityType": "WIX_USER"
}
}
}There is 1 error with this status code.
There are 3 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.