C++

Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name. C++

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkHttp http;

    // First, let's search for the category by name because we'll need to know the category's id to delete.

    // Sends the following POST

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

    CkJsonObject json;
    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
    CkJsonObject jsonToken;
    jsonToken.LoadFile("qa_data/tokens/shopware6.json");

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

    // Note: If you get a 401 response status code, then fetch a new access token and retry.
    CkHttpResponse resp;
    success = http.HttpJson("POST","https://my-shopware-6-shop.de/api/v3/search/category",json,"application/json",resp);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp.GetBodySb(sbResponseBody);
    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    // 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.get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp.header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        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) {
        std::cout << "numSearchResults = " << numSearchResults << "\r\n";
        std::cout << "Did not find the category, or unexpectedly found more than one with the same name." << "\r\n";
        return;
    }

    const char *categoryId = jResp.stringOf("data[0].id");

    std::cout << "Category ID = " << categoryId << "\r\n";

    // -----------------------------------------------------------------------------------------------
    // Delete this category by the given ID.

    // We need to send a DELETE request like this:
    // DELETE /api/v3/category/5840ff0975ac428ebf7838359e47737f

    CkStringBuilder sbUrl;
    sbUrl.Append("https://my-shopware-6-shop.de/api/v3/category/");
    sbUrl.Append(categoryId);

    // If successful (204 response code), then the jsonStr will be empty.
    // Otherwise it will be a JSON error message.
    const char *jsonStr = http.quickDeleteStr(sbUrl.getAsString());
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    // A 204 status code indicates success.
    respStatusCode = http.get_LastStatus();
    std::cout << "Response status code for DELETE: " << respStatusCode << "\r\n";

    // This will be non-empty if an error occurred.
    std::cout << jsonStr << "\r\n";
    }