Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB
Endpoints

Get a review by ID

This endpoint retrieves a review by its ID.

get/reviews/{reviewId}

Path parameters

reviewIdstring required

The review ID.

Example: rev-xxxxxxxa-yyyy-xxxx-yyyy-xxxxxxxxxxxx

Headers

Authorizationstring required

An OAuth2 authorization header with an access token, see OAuth2

Response

The review with the specified ID.

_objectstring required

The object type of this response object, which is CustomerReview.

idstring required

The customer review UUID.

accountRefstring required

A UUID as account reference.

channelRefstring required

A UUID as channel reference.

inviteRefstring

A UUID as invite reference.

ratingnumber required

The star rating.

The value ranges from 1.0 to 5.0.

titlestring required

A title headline for this customer review.

commentstring required

The review text for this customer review.

createdAtstring date-time required

The date and time when the customer review was stored initially, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats. This date will be after submittedAt for imported reviews.

updatedAtstring date-time required

The date and time when the customer review was last modified, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats.

submittedAtstring date-time required

The date and time when the customer review was submitted by the reviewer, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats.

feedbackType'REVIEW' | 'STATEMENT'

The feedback type which is determined by the customer review title, comment and rating. The type is REVIEW unless either the comment or the rating are missing. In that case it is STATEMENT.

state'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'MODERATION' | 'DISCARDED' required

The state of the customer review when the API request was processed. See our glossary entry for more information on review states.

type'SERVICE_REVIEW' | 'PRODUCT_REVIEW' required

The customer review type.

A service review is a review for a channel as a whole, e.g. a shop or a store, while a product review is tied to a single product.

verificationType'VERIFIED' | 'UNDEFINED'

Specifies whether the collection method in combination with the provider/source can be trusted. A Review will be VERIFIED unless it comes from an external import by an account that is not explicitly marked as verified.

metadataobject

The metadata object is a collection of user-defined data added to the customer review.

surveyDataobject

The surveyData object holds custom response data from additional questions from eTrusted questionnaires.

hasAttachmentsboolean

This indicates if the whether the customer review has attachments, such as images.

editedAtstring date-time

The date and time when the customer review was last edited by the consumer via our B2C world, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ. Check the glossary for examples of valid datetime formats. Will not be present in the response when the review was never edited by the consumer.

Example response

{
  "_object": "CustomerReview",
  "id": "rev-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
  "accountRef": "acc-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
  "channelRef": "chl-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
  "inviteRef": "inv-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
  "rating": 4.6,
  "title": "Great experience",
  "comment": "Everything went well. Very helpful staff!",
  "createdAt": "2018-02-01T17:09:41.790Z",
  "updatedAt": "2018-02-01T17:09:41.790Z",
  "submittedAt": "2018-02-01T17:09:41.790Z",
  "state": "APPROVED",
  "reply": {
    "createdAt": "2018-02-01T17:10:42.733Z",
    "updatedAt": "2018-02-01T17:11:33.121Z",
    "comment": "We appreciate your feedback."
  },
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "mobile": "+123456789"
  },
  "transaction": {
    "reference": "ORDER-12792",
    "date": "2018-01-04T12:09:50.722Z"
  },
  "event": {
    "id": "evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
    "type": "checkout"
  },
  "metadata": {
    "customParam1": "customVal1",
    "customParam2": "customVal2"
  },
  "surveyData": {
    "responseParam1": "responseVal1",
    "responseParam2": "responseVal2"
  },
  "questionnaire": {
    "id": "qre-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
    "locale": "en_GB",
    "templateRef": "qrt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
  },
  "additionalInformation": {
    "veto": {
      "createdAt": "2018-02-01T17:09:41.790Z",
      "comment": "Example comment",
      "ticketId": "123123"
    },
    "attachments": {
      "images": [
        {
          "id": "atc-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
          "extensions": "png",
          "urlOriginal": "https://attachments.etrusted.koeln/attachments/id/more/directories/image.png",
          "pathOriginal": "/attachments/id/more/directories/image.png",
          "pathThumbnail": "/attachments/id/more/directories/image.png",
          "pathLarge": "/attachments/id/more/directories/image.png"
        }
      ]
    },
    "originalReview": {
      "title": "Great experience",
      "comment": "Everything went well. Very helpful staff!",
      "reply": {
        "createdAt": "2018-02-01T17:10:42.733Z",
        "updatedAt": "2018-02-01T17:11:33.121Z",
        "comment": "We appreciate your feedback."
      }
    }
  },
  "product": {
    "id": "prt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
    "sku": "1234-TS-WH-M",
    "mpn": "23687778",
    "name": "Specialbrand T-Shirt White M",
    "url": "http://www.specialbrandshop.com/article123-TS-WH-M/",
    "imageUrl": "https://www.specialbrandshop.com/article123-TS-WH-M/image.jpg",
    "brand": "specialbrand"
  },
  "editedAt": "2018-02-01T17:09:41.790Z",
  "originalReview": {
    "comment": "It was a very good experience. The service team is very friendly and the prices are good. I can only recommend this store.",
    "title": "It was a very good experience.",
    "reply": {
      "replyComment": "We appreciate your feedback.",
      "replyCreatedAt": "2018-02-01T17:10:42.733Z",
      "replyUpdatedAt": "2018-02-01T17:11:33.121Z"
    }
  }
}