Swift

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

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

    let json = CkoJsonObject()!
    json.updateInt(jsonPath: "page", value: 1)
    json.updateInt(jsonPath: "limit", value: 3)
    json.updateString(jsonPath: "aggregations[0].type", value: "avg")
    json.updateString(jsonPath: "aggregations[0].field", value: "points")
    json.updateString(jsonPath: "aggregations[0].name", value: "rating-average")
    json.updateString(jsonPath: "includes.product_review[0]", value: "id")
    json.updateString(jsonPath: "includes.product_review[1]", value: "content")
    json.updateString(jsonPath: "includes.product_review[2]", value: "title")
    json.updateString(jsonPath: "includes.product_review[3]", value: "createdAt")
    json.updateString(jsonPath: "includes.product_review[4]", value: "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(name: "sw-access-key", value: "<sales-channel-api-access-key>")

    http.setUrlVar(name: "id", value: "07afcfeb9725469cacb0010000731838")

    let resp = CkoHttpResponse()!
    success = http.httpJson(verb: "POST", url: "https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews", json: json, contentType: "application/json", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp.getBodySb(sb: sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sb: sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    var respStatusCode: Int = resp.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp.header!)")
        print("Failed.")
        return
    }

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

    var points: Int
    var content: String?
    var title: String?
    var createdAt: String?
    var id: String?

    var total: Int = jResp.int(of: "total").intValue
    var aggregationsRating_averageAvg: Int = jResp.int(of: "aggregations.rating-average.avg").intValue
    var aggregationsRating_averageApiAlias: String? = jResp.string(of: "aggregations.rating-average.apiAlias")
    var apiAlias: String? = jResp.string(of: "apiAlias")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "elements").intValue
    while i < count_i {
        jResp.i = i
        points = jResp.int(of: "elements[i].points").intValue
        content = jResp.string(of: "elements[i].content")
        title = jResp.string(of: "elements[i].title")
        createdAt = jResp.string(of: "elements[i].createdAt")
        id = jResp.string(of: "elements[i].id")
        apiAlias = jResp.string(of: "elements[i].apiAlias")
        i = i + 1
    }


}