(JavaScript) Shopware 6 - Delete Category

See more Shopware 6 Examples

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

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

var json = new CkJsonObject();
json.UpdateString("filter[0].type","equals");
json.UpdateString("filter[0].field","name");
json.UpdateString("filter[0].value","Test123");
json.UpdateString("includes.category[0]","id");
json.UpdateString("includes.category[1]","name");

// Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
var jsonToken = new CkJsonObject();
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.
var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://my-shopware-6-shop.de/api/v3/search/category",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("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": [
//   ]
// }

var numSearchResults = jResp.SizeOfArray("data");
if (numSearchResults !== 1) {
    console.log("numSearchResults = " + numSearchResults);
    console.log("Did not find the category, or unexpectedly found more than one with the same name.");
    return;
}

var categoryId = jResp.StringOf("data[0].id");

console.log("Category ID = " + categoryId);

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

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

var sbUrl = new CkStringBuilder();
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.
var jsonStr = http.QuickDeleteStr(sbUrl.GetAsString());
if (http.LastMethodSuccess == false) {
    console.log(http.LastErrorText);
    return;
}

// A 204 status code indicates success.
respStatusCode = http.LastStatus;
console.log("Response status code for DELETE: " + respStatusCode);

// This will be non-empty if an error occurred.
console.log(jsonStr);