(PHP Extension) Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$http = new CkHttp();

// 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 = new CkJsonObject();
$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 = new CkJsonObject();
$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.
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://my-shopware-6-shop.de/api/v3/search/category','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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) {
    print 'numSearchResults = ' . $numSearchResults . "\n";
    print 'Did not find the category, or unexpectedly found more than one with the same name.' . "\n";
    exit;
}

$categoryId = $jResp->stringOf('data[0].id');

print 'Category ID = ' . $categoryId . "\n";

?>