Java

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example assumes the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Http http = new 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

        JsonObject json = new JsonObject();
        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");

        HttpResponse resp = new HttpResponse();
        try {
            http.httpJson("POST", "https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews", json, "application/json", resp);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        StringBuilder sbResponseBody = new StringBuilder();
        resp.getBodySb(sbResponseBody);
        JsonObject jResp = new JsonObject();
        jResp.loadSb(sbResponseBody);
        jResp.setEmitCompact(false);

        System.out.println("Response Body:");
        System.out.println(jResp.emit());

        // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
        int respStatusCode = resp.getStatusCode();
        System.out.println("Response Status Code = " + respStatusCode);
        if (respStatusCode >= 400) {
            System.out.println("Response Header:");
            System.out.println(resp.getHeader());
            System.out.println("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

        int points = 0;
        String content = "";
        String title = "";
        String createdAt = "";
        String id = "";

        int total = jResp.intOf("total");
        int aggregationsRating_averageAvg = jResp.intOf("aggregations.rating-average.avg");
        String aggregationsRating_averageApiAlias = jResp.stringOf("aggregations.rating-average.apiAlias");
        String apiAlias = jResp.stringOf("apiAlias");
        int i = 0;
        int count_i = jResp.sizeOfArray("elements");
        while (i < count_i) {
            jResp.setI(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;
        }
    }
}