(JavaScript) Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

For more information, see https://docs.shopware.com/en/shopware-platform-dev-en/store-api-guide/products

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var http = new CkHttp();

// Sends the following POST

// POST /store-api/v1/product/07afcfeb9725469cacb0010000731838/reviews
// {   
//     "page": 1,
//     "limit": 3,
//     "aggregations": [
//         { "type": "avg", "field": "points", "name": "rating-average"}
//     ],
//     "includes": {
//         "product_review": ["id", "content", "title", "createdAt", "points"]
//     }
// }

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

var json = new CkJsonObject();
json.UpdateInt("page",1);
json.UpdateInt("limit",3);
json.UpdateString("aggregations[0].type","avg");
json.UpdateString("aggregations[0].field","points");
json.UpdateString("aggregations[0].name","rating-average");
json.UpdateString("includes.product_review[0]","id");
json.UpdateString("includes.product_review[1]","content");
json.UpdateString("includes.product_review[2]","title");
json.UpdateString("includes.product_review[3]","createdAt");
json.UpdateString("includes.product_review[4]","points");

// This request simply authenticates with the sw-access-key you can interactively copy from your 
// sales channel in the Shopware 6 administration web portal.
// We do NOT use OAuth2 for Store API requests.
http.SetRequestHeader("sw-access-key","<sales-channel-api-access-key>");

http.SetUrlVar("id","07afcfeb9725469cacb0010000731838");

var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//     "total": 3,
//     "aggregations": {
//         "rating-average": {
//             "avg": 5,
//             "apiAlias": "rating-average_aggregation"
//         }
//     },
//     "elements": [
//         {
//             "points": 5,
//             "content": "Lorem ipsum dolor ... sit amet.",
//             "title": "Really cool product",
//             "createdAt": "2020-08-27T09:49:48.776+00:00",
//             "id": "0fa91ce3e96a4bc2be4bd9ce752c3425",
//             "apiAlias": "product_review"
//         },
//         {
//             "points": 5,
//             "content": "Lorem ipsum dolor ... sit amet.",
//             "title": "Really cool product",
//             "createdAt": "2020-08-27T09:49:48.776+00:00",
//             "id": "211c5785d293434c9ef3c624c675f545",
//             "apiAlias": "product_review"
//         },
//         {
//             "points": 5,
//             "content": "Lorem ipsum dolor ... sit amet.",
//             "title": "Really cool product",
//             "createdAt": "2020-08-27T09:49:48.776+00:00",
//             "id": "2fbb5fe2e29a4d70aa5854ce7ce3e20b",
//             "apiAlias": "product_review"
//         }
//     ],
//     "apiAlias": "dal_entity_search_result"
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

var points;
var content;
var title;
var createdAt;
var id;

var total = jResp.IntOf("total");
var aggregationsRating_averageAvg = jResp.IntOf("aggregations.rating-average.avg");
var aggregationsRating_averageApiAlias = jResp.StringOf("aggregations.rating-average.apiAlias");
var apiAlias = jResp.StringOf("apiAlias");
var i = 0;
var count_i = jResp.SizeOfArray("elements");
while (i < count_i) {
    jResp.I = i;
    points = jResp.IntOf("elements[i].points");
    content = jResp.StringOf("elements[i].content");
    title = jResp.StringOf("elements[i].title");
    createdAt = jResp.StringOf("elements[i].createdAt");
    id = jResp.StringOf("elements[i].id");
    apiAlias = jResp.StringOf("elements[i].apiAlias");
    i = i+1;
}