C

Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttp http;
    HCkJsonObject json;
    HCkJsonObject jsonToken;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    int numSearchResults;
    const char *categoryId;

    success = FALSE;

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

    http = CkHttp_Create();

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

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"filter[0].type","equals");
    CkJsonObject_UpdateString(json,"filter[0].field","name");
    CkJsonObject_UpdateString(json,"filter[0].value","Test123");
    CkJsonObject_UpdateString(json,"includes.category[0]","id");
    CkJsonObject_UpdateString(json,"includes.category[1]","name");

    // Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
    jsonToken = CkJsonObject_Create();
    CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/shopware6.json");

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

    // Note: If you get a 401 response status code, then fetch a new access token and retry.
    resp = CkHttpResponse_Create();
    success = CkHttp_HttpJson(http,"POST","https://my-shopware-6-shop.de/api/v3/search/category",json,"application/json",resp);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkJsonObject_Dispose(jsonToken);
        CkHttpResponse_Dispose(resp);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);
    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkJsonObject_Dispose(jsonToken);
        CkHttpResponse_Dispose(resp);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        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": [
    //   ]
    // }

    numSearchResults = CkJsonObject_SizeOfArray(jResp,"data");
    if (numSearchResults != 1) {
        printf("numSearchResults = %d\n",numSearchResults);
        printf("Did not find the category, or unexpectedly found more than one with the same name.\n");
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkJsonObject_Dispose(jsonToken);
        CkHttpResponse_Dispose(resp);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    categoryId = CkJsonObject_stringOf(jResp,"data[0].id");

    printf("Category ID = %s\n",categoryId);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkJsonObject_Dispose(jsonToken);
    CkHttpResponse_Dispose(resp);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }