Skip to content

Project review

idintegerrequired

Review id.

datestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

Review creation date.

orderCodenull or stringrequired

Order code related to review. Can be null.

ratingintegerrequired

Number from 1 to 5 representing starts of review's rating.

descriptionnull or stringrequired
fullNamenull or stringrequired

Fullname of review's author. Can be null.

emailnull or stringrequired

Email of the review author. If it's a registered customer and the review email is empty, it's filled with the customer's main account email. Can be null.

customerGuidnull or stringrequired

Customer guid related to review. Can be null.

visiblebooleanrequired

flag, whether the review is visible

reactionobjectrequired
{
  "id": 1,
  "date": "2018-05-29T09:02:27+0200",
  "orderCode": "2011000002",
  "rating": 5,
  "description": "Snack was very good",
  "fullName": "John Doe",
  "email": "johndoe@email.tld",
  "customerGuid": "443cad54-73bc-11e8-8216-002590dad85e",
  "visible": false,
  "reaction": {
    "reactionCreated": "2018-05-29T09:02:27+0200",
    "reactionFullName": "John Doe",
    "reactionEmail": "johndoe@email.tld",
    "reactionText": "Thank you for your review!"
  }
}