(Node.js) Shopware 6 - Find Category by Name

See more Shopware 6 Examples

Find a category with a given name and get the id.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // Sends the following POST to find the category named "Test123"

    // 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 chilkat.JsonObject();
    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 chilkat.JsonObject();
    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.
    // resp: HttpResponse
    var resp = http.PostJson3("https://my-shopware-6-shop.de/api/v3/search/category","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);
    var jResp = new chilkat.JsonObject();
    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);

}

chilkatExample();