ProductReviewsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing review.  This endpoint allows you to update any specific product review in your store.

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
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  You should also have one or more product reviews created so that you can successfully find one to update.

ProductReviewsUpdate

This REST API endpoint allows you to update a product review in your store. This requires that you also have a product review to update, which would mean that you should also call the ProductReviewsFind endpoint to get an existing product review.

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/productreviews/[BVIN]

BVIN is the product review ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the product review that you wish to update
data You will need to pass an updated JSON version of the ProductReviewDTO object in your post request

Returns

If successful, this endpoint will return a populated ProductReviewDTO object in JSON format.  Otherwise, you should have one or more errors returned.  

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Catalog
  • Hotcakes.CommerceDTO.v1.Client

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify the product to find and update
var productReviewId = "027badec-23c5-46bc-bc06-6f815b8692a7";

// call the API to find the product review
var review = proxy.ProductReviewsFind(productReviewId).Content;

// update one or more properties
review.Approved = false;

// call the API to update the product review
ApiResponse<ProductReviewDTO> response = proxy.ProductReviewsUpdate(review);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "productreviews";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the product to find and update
    var productReviewId = "027badec-23c5-46bc-bc06-6f815b8692a7";

    // call the API to find the product review
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + productReviewId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the product review in another method
            UpdateProductReview(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateProductReview(review) {

    // update one or more properties
    review.Approved = false;

    // convert the UTC date safely
    review.ReviewDateUtc = ParseDateForSave(review.ReviewDateUtc);

    // call the API to update the product review
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + review.Bvin + "?key=" + apiKey,
        data: JSON.stringify(review),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}

function ParseDateForSave(dateValue) {
    // create a new date object in UTC format
    var newDate = new Date(parseInt(dateValue.substr(6)));

    // return the UTC version of the date
    return newDate.toISOString();
}
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"027badec-23c5-46bc-bc06-6f815b8692a7",
      "UserID":"2",
      "ProductBvin":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
      "ReviewDateUtc":"\/Date(1403136420427)\/",
      "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.