Delphi DLL

Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
json: HCkJsonObject;
jsonToken: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
numSearchResults: Integer;
categoryId: PWideChar;
sbUrl: HCkStringBuilder;
jsonStr: PWideChar;

begin
success := False;

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

http := CkHttp_Create();

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

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) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

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

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(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);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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) then
  begin
    Memo1.Lines.Add('numSearchResults = ' + IntToStr(numSearchResults));
    Memo1.Lines.Add('Did not find the category, or unexpectedly found more than one with the same name.');
    Exit;
  end;

categoryId := CkJsonObject__stringOf(jResp,'data[0].id');

Memo1.Lines.Add('Category ID = ' + categoryId);

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

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

sbUrl := CkStringBuilder_Create();
CkStringBuilder_Append(sbUrl,'https://my-shopware-6-shop.de/api/v3/category/');
CkStringBuilder_Append(sbUrl,categoryId);

// If successful (204 response code), then the jsonStr will be empty.
// Otherwise it will be a JSON error message.
jsonStr := CkHttp__quickDeleteStr(http,CkStringBuilder__getAsString(sbUrl));
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

// A 204 status code indicates success.
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response status code for DELETE: ' + IntToStr(respStatusCode));

// This will be non-empty if an error occurred.
Memo1.Lines.Add(jsonStr);

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

end;