Dart

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

Get the reviews of a single product (specified by product id). Dart

import 'package:chilkat/chilkat.dart';

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

  final http = 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

  final json = 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');

  final resp = CkHttpResponse();
  try {
    http.httpJson('POST', 'https://my-shopware-6-shop.de/store-api/v3/product/{\$id}/reviews', json, 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);
  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('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 = 0;
  var content = '';
  var title = '';
  var createdAt = '';
  var id = '';

  final total = jResp.intOf('total');
  final aggregationsRatingAverageAvg = jResp.intOf('aggregations.rating-average.avg');
  final aggregationsRatingAverageApiAlias = jResp.stringOf('aggregations.rating-average.apiAlias');
  var apiAlias = jResp.stringOf('apiAlias');
  var i = 0;
  final countI = jResp.sizeOfArray('elements');
  while (i < countI) {
    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++;
  }
}