B4X

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("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

Dim json As ChilkatJsonObject
json.Initialize
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")

Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews", json, "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Log("Response Body:")
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.
Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(resp.Header)
    Log("Failed.")
    Return
End If


'  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

Dim points As Int
Dim content As String
Dim title As String
Dim createdAt As String
Dim id As String

Dim total As Int = jResp.IntOf("total")
Dim aggregationsRating_averageAvg As Int = jResp.IntOf("aggregations.rating-average.avg")
Dim aggregationsRating_averageApiAlias As String = jResp.StringOf("aggregations.rating-average.apiAlias")
Dim apiAlias As String = jResp.StringOf("apiAlias")
Dim i As Int = 0
Dim count_i As Int = jResp.SizeOfArray("elements")
Do 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
Loop