Objective-C

Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name. 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];

// First, let's search for the category by name because we'll need to know the category's id to delete.

// Sends the following POST

// POST /api/v3/search/category
// {
//     "filter": [
//         { "type": "equals", "field": "name", "value": "Test123" }
//     ],
//     "includes": {
//         "category": ["id", "name"]
//     }
// }

// Create the above JSON.
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"filter[0].type" value: @"equals"];
[json UpdateString: @"filter[0].field" value: @"name"];
[json UpdateString: @"filter[0].value" value: @"Test123"];
[json UpdateString: @"includes.category[0]" value: @"id"];
[json UpdateString: @"includes.category[1]" value: @"name"];

// Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
[jsonToken LoadFile: @"qa_data/tokens/shopware6.json"];

// This causes the "Authorization: Bearer <access_token>" header to be added.
http.AuthToken = [jsonToken StringOf: @"access_token"];

// Note: If you get a 401 response status code, then fetch a new access token and retry.
CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpJson: @"POST" url: @"https://my-shopware-6-shop.de/api/v3/search/category" 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;
}

// The response looks like this:
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

// {
//   "data": [
//     {
//       "id": "89c4131789fd422c8f00cf37bbb83330",
//       "type": "category",
//       "attributes": {
//         "name": "Test123",
//         "apiAlias": null
//       },
//       "links": {
//         "self": "https:\/\/***.de\/api\/v3\/category\/89c4131789fd422c8f00cf37bbb83330"
//       },
//       "relationships": [
//       ],
//       "meta": null
//     }
//   ],
//   "included": [
//   ],
//   "links": {
//     "self": "https:\/\/***.de\/api\/v3\/search\/category"
//   },
//   "meta": {
//     "totalCountMode": 0,
//     "total": 1
//   },
//   "aggregations": [
//   ]
// }

int numSearchResults = [[jResp SizeOfArray: @"data"] intValue];
if (numSearchResults != 1) {
    NSLog(@"%@%d",@"numSearchResults = ",numSearchResults);
    NSLog(@"%@",@"Did not find the category, or unexpectedly found more than one with the same name.");
    return;
}

NSString *categoryId = [jResp StringOf: @"data[0].id"];

NSLog(@"%@%@",@"Category ID = ",categoryId);

// -----------------------------------------------------------------------------------------------
// Delete this category by the given ID.

// We need to send a DELETE request like this:
// DELETE /api/v3/category/5840ff0975ac428ebf7838359e47737f

CkoStringBuilder *sbUrl = [[CkoStringBuilder alloc] init];
[sbUrl Append: @"https://my-shopware-6-shop.de/api/v3/category/"];
[sbUrl Append: categoryId];

// If successful (204 response code), then the jsonStr will be empty.
// Otherwise it will be a JSON error message.
NSString *jsonStr = [http QuickDeleteStr: [sbUrl GetAsString]];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// A 204 status code indicates success.
respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response status code for DELETE: ",respStatusCode);

// This will be non-empty if an error occurred.
NSLog(@"%@",jsonStr);