(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http
Dim success As Boolean

// 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 New Chilkat.JsonObject
success = json.UpdateInt("page",1)
success = json.UpdateInt("limit",3)
success = json.UpdateString("aggregations[0].type","avg")
success = json.UpdateString("aggregations[0].field","points")
success = json.UpdateString("aggregations[0].name","rating-average")
success = json.UpdateString("includes.product_review[0]","id")
success = json.UpdateString("includes.product_review[1]","content")
success = json.UpdateString("includes.product_review[2]","title")
success = json.UpdateString("includes.product_review[3]","createdAt")
success = 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>"

success = http.SetUrlVar("id","07afcfeb9725469cacb0010000731838")

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(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 Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("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 Int32
Dim content As String
Dim title As String
Dim createdAt As String
Dim id As String

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