(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
points: Integer;
content: PWideChar;
title: PWideChar;
createdAt: PWideChar;
id: PWideChar;
total: Integer;
aggregationsRating_averageAvg: Integer;
aggregationsRating_averageApiAlias: PWideChar;
apiAlias: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

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

json := CkJsonObject_Create();
CkJsonObject_UpdateInt(json,'page',1);
CkJsonObject_UpdateInt(json,'limit',3);
CkJsonObject_UpdateString(json,'aggregations[0].type','avg');
CkJsonObject_UpdateString(json,'aggregations[0].field','points');
CkJsonObject_UpdateString(json,'aggregations[0].name','rating-average');
CkJsonObject_UpdateString(json,'includes.product_review[0]','id');
CkJsonObject_UpdateString(json,'includes.product_review[1]','content');
CkJsonObject_UpdateString(json,'includes.product_review[2]','title');
CkJsonObject_UpdateString(json,'includes.product_review[3]','createdAt');
CkJsonObject_UpdateString(json,'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.
CkHttp_SetRequestHeader(http,'sw-access-key','<sales-channel-api-access-key>');

CkHttp_SetUrlVar(http,'id','07afcfeb9725469cacb0010000731838');

resp := CkHttp_PostJson3(http,'https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// 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 := CkJsonObject_IntOf(jResp,'total');
aggregationsRating_averageAvg := CkJsonObject_IntOf(jResp,'aggregations.rating-average.avg');
aggregationsRating_averageApiAlias := CkJsonObject__stringOf(jResp,'aggregations.rating-average.apiAlias');
apiAlias := CkJsonObject__stringOf(jResp,'apiAlias');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'elements');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    points := CkJsonObject_IntOf(jResp,'elements[i].points');
    content := CkJsonObject__stringOf(jResp,'elements[i].content');
    title := CkJsonObject__stringOf(jResp,'elements[i].title');
    createdAt := CkJsonObject__stringOf(jResp,'elements[i].createdAt');
    id := CkJsonObject__stringOf(jResp,'elements[i].id');
    apiAlias := CkJsonObject__stringOf(jResp,'elements[i].apiAlias');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;