Lua

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

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

local json = chilkat.JsonObject.new()
json:update_int("page", 1)
json:update_int("limit", 3)
json:update_string("aggregations[0].type", "avg")
json:update_string("aggregations[0].field", "points")
json:update_string("aggregations[0].name", "rating-average")
json:update_string("includes.product_review[0]", "id")
json:update_string("includes.product_review[1]", "content")
json:update_string("includes.product_review[2]", "title")
json:update_string("includes.product_review[3]", "createdAt")
json:update_string("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:set_request_header("sw-access-key", "<sales-channel-api-access-key>")

http:set_url_var("id", "07afcfeb9725469cacb0010000731838")

local resp = chilkat.HttpResponse.new()
local success = http:http_json("POST", "https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews", json, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = 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.
local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
end

-- 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 points = 0
local content = ""
local title = ""
local createdAt = ""
local id = ""

local total = jResp:int_of("total")
local aggregationsRating_averageAvg = jResp:int_of("aggregations.rating-average.avg")
local aggregationsRating_averageApiAlias = jResp:string_of("aggregations.rating-average.apiAlias")
local apiAlias = jResp:string_of("apiAlias")
local i = 0
local count_i = jResp:size_of_array("elements")
while i < count_i do
    jResp.i = i
    points = jResp:int_of("elements[i].points")
    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
end