Pascal (Lazarus/Delphi)

Shopware 6 - Find Category by Name

See more Shopware 6 Examples

Find a category with a given name and get the id. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Http,
  Chilkat.StringBuilder,
  Chilkat.HttpResponse,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  http: THttp;
  json: TJsonObject;
  jsonToken: TJsonObject;
  resp: THttpResponse;
  sbResponseBody: TStringBuilder;
  jResp: TJsonObject;
  respStatusCode: Integer;
  numSearchResults: Integer;
  categoryId: string;

begin
  success := False;

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

  http := THttp.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 := TJsonObject.Create;
  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
  jsonToken := TJsonObject.Create;
  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.
  resp := THttpResponse.Create;
  success := http.HttpJson('POST','https://my-shopware-6-shop.de/api/v3/search/category',json,'application/json',resp);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  sbResponseBody := TStringBuilder.Create;
  resp.GetBodySb(sbResponseBody);
  jResp := TJsonObject.Create;
  jResp.LoadSb(sbResponseBody);
  jResp.EmitCompact := False;

  WriteLn('Response Body:');
  WriteLn(jResp.Emit());

  //  If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
  respStatusCode := resp.StatusCode;
  WriteLn('Response Status Code = ' + respStatusCode);
  if (respStatusCode >= 400) then
    begin
      WriteLn('Response Header:');
      WriteLn(resp.Header);
      WriteLn('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 := jResp.SizeOfArray('data');
  if (numSearchResults <> 1) then
    begin
      WriteLn('numSearchResults = ' + numSearchResults);
      WriteLn('Did not find the category, or unexpectedly found more than one with the same name.');
      Exit;
    end;

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

  WriteLn('Category ID = ' + categoryId);


  http.Free;
  json.Free;
  jsonToken.Free;
  resp.Free;
  sbResponseBody.Free;
  jResp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.