(SQL Server) 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

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'page', 1
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'limit', 3
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'aggregations[0].type', 'avg'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'aggregations[0].field', 'points'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'aggregations[0].name', 'rating-average'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.product_review[0]', 'id'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.product_review[1]', 'content'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.product_review[2]', 'title'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.product_review[3]', 'createdAt'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, '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.
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'sw-access-key', '<sales-channel-api-access-key>'

    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'id', '07afcfeb9725469cacb0010000731838'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
    DECLARE @jResp int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

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

    DECLARE @points int

    DECLARE @content nvarchar(4000)

    DECLARE @title nvarchar(4000)

    DECLARE @createdAt nvarchar(4000)

    DECLARE @id nvarchar(4000)

    DECLARE @total int
    EXEC sp_OAMethod @jResp, 'IntOf', @total OUT, 'total'
    DECLARE @aggregationsRating_averageAvg int
    EXEC sp_OAMethod @jResp, 'IntOf', @aggregationsRating_averageAvg OUT, 'aggregations.rating-average.avg'
    DECLARE @aggregationsRating_averageApiAlias nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @aggregationsRating_averageApiAlias OUT, 'aggregations.rating-average.apiAlias'
    DECLARE @apiAlias nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @apiAlias OUT, 'apiAlias'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'elements'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'IntOf', @points OUT, 'elements[i].points'
        EXEC sp_OAMethod @jResp, 'StringOf', @content OUT, 'elements[i].content'
        EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'elements[i].title'
        EXEC sp_OAMethod @jResp, 'StringOf', @createdAt OUT, 'elements[i].createdAt'
        EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'elements[i].id'
        EXEC sp_OAMethod @jResp, 'StringOf', @apiAlias OUT, 'elements[i].apiAlias'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO