(Perl) Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

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

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

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

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

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