Sample code for 30+ languages & platforms
Xbase++

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

Chilkat Xbase++ Downloads

Xbase++
LOCAL nSuccess
LOCAL oHttp
LOCAL oJson
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL nPoints
LOCAL cContent
LOCAL cTitle
LOCAL cCreatedAt
LOCAL cId
LOCAL nTotal
LOCAL nAggregationsRating_averageAvg
LOCAL cAggregationsRating_averageApiAlias
LOCAL cApiAlias
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

oHttp := CreateObject("Chilkat.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

oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateInt("page", 1)
oJson:UpdateInt("limit", 3)
oJson:UpdateString("aggregations[0].type", "avg")
oJson:UpdateString("aggregations[0].field", "points")
oJson:UpdateString("aggregations[0].name", "rating-average")
oJson:UpdateString("includes.product_review[0]", "id")
oJson:UpdateString("includes.product_review[1]", "content")
oJson:UpdateString("includes.product_review[2]", "title")
oJson:UpdateString("includes.product_review[3]", "createdAt")
oJson: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.
oHttp:SetRequestHeader("sw-access-key", "<sales-channel-api-access-key>")

oHttp:SetUrlVar("id", "07afcfeb9725469cacb0010000731838")

oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", "https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews", oJson, "application/json", oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oJson:destroy()
    oResp:destroy()
    RETURN
ENDIF

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

//  If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oResp:Header
    ? "Failed."
    oHttp:destroy()
    oJson:destroy()
    oResp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
ENDIF

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

nTotal := oJResp:IntOf("total")
nAggregationsRating_averageAvg := oJResp:IntOf("aggregations.rating-average.avg")
cAggregationsRating_averageApiAlias := oJResp:StringOf("aggregations.rating-average.apiAlias")
cApiAlias := oJResp:StringOf("apiAlias")
i := 0
nCount_i := oJResp:SizeOfArray("elements")
DO WHILE i < nCount_i
    oJResp:I := i
    nPoints := oJResp:IntOf("elements[i].points")
    cContent := oJResp:StringOf("elements[i].content")
    cTitle := oJResp:StringOf("elements[i].title")
    cCreatedAt := oJResp:StringOf("elements[i].createdAt")
    cId := oJResp:StringOf("elements[i].id")
    cApiAlias := oJResp:StringOf("elements[i].apiAlias")
    i := i + 1
ENDDO

oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()