Objective-C

Shopware 6 - Get Reviews of a Product

See more Shopware 6 Examples

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

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

BOOL success = NO;

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

CkoHttp *http = [[CkoHttp alloc] init];

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"page" value: [NSNumber numberWithInt: 1]];
[json UpdateInt: @"limit" value: [NSNumber numberWithInt: 3]];
[json UpdateString: @"aggregations[0].type" value: @"avg"];
[json UpdateString: @"aggregations[0].field" value: @"points"];
[json UpdateString: @"aggregations[0].name" value: @"rating-average"];
[json UpdateString: @"includes.product_review[0]" value: @"id"];
[json UpdateString: @"includes.product_review[1]" value: @"content"];
[json UpdateString: @"includes.product_review[2]" value: @"title"];
[json UpdateString: @"includes.product_review[3]" value: @"createdAt"];
[json UpdateString: @"includes.product_review[4]" value: @"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" value: @"<sales-channel-api-access-key>"];

[http SetUrlVar: @"id" value: @"07afcfeb9725469cacb0010000731838"];

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpJson: @"POST" url: @"https://my-shopware-6-shop.de/store-api/v3/product/{$id}/reviews" json: json contentType: @"application/json" response: resp];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[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.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"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;
NSString *content = 0;
NSString *title = 0;
NSString *createdAt = 0;
NSString *id = 0;

int total = [[jResp IntOf: @"total"] intValue];
int aggregationsRating_averageAvg = [[jResp IntOf: @"aggregations.rating-average.avg"] intValue];
NSString *aggregationsRating_averageApiAlias = [jResp StringOf: @"aggregations.rating-average.apiAlias"];
NSString *apiAlias = [jResp StringOf: @"apiAlias"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"elements"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    points = [[jResp IntOf: @"elements[i].points"] intValue];
    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;
}