(Node.js) Shopware 6 - List Categories

See more Shopware 6 Examples

Get a list of categories.

For more information, see https://docs.shopware.com/en/shopware-platform-dev-en/store-api-guide/navigation?category=shopware-platform-dev-en/store-api-guide

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

    // POST /store-api/v3/category
    // {
    //     "includes": {
    //         "category": ["id", "name"]
    //     }
    // }

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

    var json = new chilkat.JsonObject();
    json.UpdateString("includes.category[0]","id");
    json.UpdateString("includes.category[1]","name");

    // This request simply authenticate 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","<sales-channel-api-access-key>");

    // resp: HttpResponse
    var resp = http.PostJson3("https://my-shopware-6-shop.de/store-api/v3/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;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "total": 2,
    //   "aggregations": [],
    //   "elements": [
    //     {
    //       "id": "00a284072bcb42ed8fee31e26ea53b60",
    //       "name": "Home",
    //       "apiAlias": "category"
    //     },
    //     {
    //       "id": "bd835e75afa14b09b7da156d095a9a30",
    //       "name": "Outdoors",
    //       "apiAlias": "category"
    //     }
    //   ],
    //   "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

    var id;
    var name;

    var total = jResp.IntOf("total");
    var apiAlias = jResp.StringOf("apiAlias");
    var i = 0;
    var count_i = jResp.SizeOfArray("elements");
    while (i < count_i) {
        jResp.I = i;
        id = jResp.StringOf("elements[i].id");
        name = jResp.StringOf("elements[i].name");
        apiAlias = jResp.StringOf("elements[i].apiAlias");
        i = i+1;
    }


}

chilkatExample();