ProductReviewDTO Object

Overview

The REST API makes extensive use of the ProductReviewDTO object whenever working with a single product review.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

ProductReviewDTO

The ProductReviewDTO object will contain all of the details of a single product review for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the ProductReviewDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
Approved 0 When moderation is enabled, this value will determine if the review will be shown to site visitors.
Bvin (empty string) This is the ID of the review.
Description (empty string) Gets or sets the comments from the reviewer that describe their feelings/experience with the product and/or service.
Karma 0 Karma is used by merchants to adjust the overall rating of a review. This property is currently not being used by the application.
ProductBvin (empty string) The unique ID of the product that this review is written for.
ProductName (empty string) Gets or sets the name of the product that this review was created for.  This is a legacy property and is currently not saved in the data source.
Rating 3 A star rating from 1-5 to reflect how good or bad the purchased product and/or service was. The possible values are:
  • ZeroStars = 0
  • OneStar = 1
  • TwoStars = 2
  • ThreeStars = 3
  • FourStars = 4
  • FiveStars = 5
ReviewDateUtc UtcNow The UTC version of the date/time stamp reflecting when the review was submitted.
UserID (empty string) The unique ID of the user account that created the review.

Example of ProductReviewDTO

{
   "Errors":[

   ],
   "Content":{
      "Bvin":"83975074-5afa-492e-85f4-8a89fe8a16b6",
      "UserID":"2",
      "ProductBvin":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
      "ReviewDateUtc":"\/Date(1403048072933)\/",
      "Rating":4,
      "Karma":0,
      "Description":"I love my brand new fedora. I just wish that the headband was a bit more comfortable.",
      "Approved":false,
      "ProductName":""
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.