(AutoIt) 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

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateInt("page",1)
$oJson.UpdateInt("limit",3)
$oJson.UpdateString("aggregations[0].type","avg")
$oJson.UpdateString("aggregations[0].field","points")
$oJson.UpdateString("aggregations[0].name","rating-average")
$oJson.UpdateString("includes.product_review[0]","id")
$oJson.UpdateString("includes.product_review[1]","content")
$oJson.UpdateString("includes.product_review[2]","title")
$oJson.UpdateString("includes.product_review[3]","createdAt")
$oJson.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.
$oHttp.SetRequestHeader "sw-access-key","<sales-channel-api-access-key>"

$oHttp.SetUrlVar("id","07afcfeb9725469cacb0010000731838")

Local $oResp = $oHttp.PostJson3("https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

; If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $iPoints
Local $sContent
Local $sTitle
Local $sCreatedAt
Local $sId

Local $iTotal = $oJResp.IntOf("total")
Local $iAggregationsRating_averageAvg = $oJResp.IntOf("aggregations.rating-average.avg")
Local $sAggregationsRating_averageApiAlias = $oJResp.StringOf("aggregations.rating-average.apiAlias")
Local $sApiAlias = $oJResp.StringOf("apiAlias")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("elements")
While $i < $iCount_i
    $oJResp.I = $i
    $iPoints = $oJResp.IntOf("elements[i].points")
    $sContent = $oJResp.StringOf("elements[i].content")
    $sTitle = $oJResp.StringOf("elements[i].title")
    $sCreatedAt = $oJResp.StringOf("elements[i].createdAt")
    $sId = $oJResp.StringOf("elements[i].id")
    $sApiAlias = $oJResp.StringOf("elements[i].apiAlias")
    $i = $i + 1
Wend