(C#) Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Chilkat.Http http = new Chilkat.Http();
bool 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

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(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;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("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");
if (numSearchResults != 1) {
    Debug.WriteLine("numSearchResults = " + Convert.ToString(numSearchResults));
    Debug.WriteLine("Did not find the category, or unexpectedly found more than one with the same name.");
    return;
}

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

Debug.WriteLine("Category ID = " + categoryId);