Java

Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example assumes the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Http http = new Http();

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

        JsonObject json = new 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
        JsonObject jsonToken = new JsonObject();
        jsonToken.loadFile("qa_data/tokens/shopware6.json");

        // This causes the "Authorization: Bearer <access_token>" header to be added.
        http.setAuthToken(jsonToken.stringOf("access_token"));

        // Note: If you get a 401 response status code, then fetch a new access token and retry.
        HttpResponse resp = new HttpResponse();
        try {
            http.httpJson("POST", "https://my-shopware-6-shop.de/api/v3/search/category", json, "application/json", resp);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        StringBuilder sbResponseBody = new StringBuilder();
        resp.getBodySb(sbResponseBody);
        JsonObject jResp = new JsonObject();
        jResp.loadSb(sbResponseBody);
        jResp.setEmitCompact(false);

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

        String categoryId = jResp.stringOf("data[0].id");

        System.out.println("Category ID = " + categoryId);
    }
}