Review Request Object


A review request is a request sent to a customer to solicit a review for a specific order or specific items.

Properties
idstringRead-onlyformat GUID

Review request ID.


revisionintegerRead-onlyformat int64

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.


createdDatestringRead-onlyformat date-time

Date and time the review request was created.


updatedDatestringRead-onlyformat date-time

Date and time the review request was last updated.


sendDatestringformat date-time

Date and time the review request was, or will be, sent. This field is only informational and does not trigger a send action.


namespacestringminLength 1maxLength 100

Name of the Wix app whose catalog the items being reviewed belong to.

Supported values:

  • Wix Stores: stores

Currently, only Wix Stores is fully integrated with the Wix Reviews app.


orderOrder

Order that a review is requested for.


itemsArray <Item>maxItems 5

Items that a review is requested for.


recipientRecipient

Customer to send a review request to.


communicationChannelstring

Communication channel for sending the review request.


statusstringRead-only

Review request status.


automationActivationIdstringformat GUID

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.


requestedByRequestedByRead-only

ID of the user or app that generated the review request.


ONE OF:

sentOptionsSentOptionsRead-only

Info if status is SENT.


failedOptionsFailedOptionsRead-only

Info if status is FAILED.

Did this help?