(PHP ActiveX) Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// 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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$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');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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

$total = $jResp->IntOf('total');
$aggregationsRating_averageAvg = $jResp->IntOf('aggregations.rating-average.avg');
$aggregationsRating_averageApiAlias = $jResp->stringOf('aggregations.rating-average.apiAlias');
$apiAlias = $jResp->stringOf('apiAlias');
$i = 0;
$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;
}


?>