(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    Integer iPoints
    String sContent
    String sTitle
    String sCreatedAt
    String sId
    Integer iTotal
    Integer iAggregationsRating_averageAvg
    String sAggregationsRating_averageApiAlias
    String sApiAlias
    Integer i
    Integer iCount_i
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateInt Of hoJson "page" 1 To iSuccess
    Get ComUpdateInt Of hoJson "limit" 3 To iSuccess
    Get ComUpdateString Of hoJson "aggregations[0].type" "avg" To iSuccess
    Get ComUpdateString Of hoJson "aggregations[0].field" "points" To iSuccess
    Get ComUpdateString Of hoJson "aggregations[0].name" "rating-average" To iSuccess
    Get ComUpdateString Of hoJson "includes.product_review[0]" "id" To iSuccess
    Get ComUpdateString Of hoJson "includes.product_review[1]" "content" To iSuccess
    Get ComUpdateString Of hoJson "includes.product_review[2]" "title" To iSuccess
    Get ComUpdateString Of hoJson "includes.product_review[3]" "createdAt" To iSuccess
    Get ComUpdateString Of hoJson "includes.product_review[4]" "points" To iSuccess

    // 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.
    Send ComSetRequestHeader To hoHttp "sw-access-key" "<sales-channel-api-access-key>"

    Get ComSetUrlVar Of hoHttp "id" "07afcfeb9725469cacb0010000731838" To iSuccess

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

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

    Get ComIntOf Of hoJResp "total" To iTotal
    Get ComIntOf Of hoJResp "aggregations.rating-average.avg" To iAggregationsRating_averageAvg
    Get ComStringOf Of hoJResp "aggregations.rating-average.apiAlias" To sAggregationsRating_averageApiAlias
    Get ComStringOf Of hoJResp "apiAlias" To sApiAlias
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "elements" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComIntOf Of hoJResp "elements[i].points" To iPoints
        Get ComStringOf Of hoJResp "elements[i].content" To sContent
        Get ComStringOf Of hoJResp "elements[i].title" To sTitle
        Get ComStringOf Of hoJResp "elements[i].createdAt" To sCreatedAt
        Get ComStringOf Of hoJResp "elements[i].id" To sId
        Get ComStringOf Of hoJResp "elements[i].apiAlias" To sApiAlias
        Move (i + 1) To i
    Loop



End_Procedure