Tcl

Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

load ./chilkat.dll

set success 0

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

set 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

set json [new_CkJsonObject]

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
set jsonToken [new_CkJsonObject]

CkJsonObject_LoadFile $jsonToken "qa_data/tokens/shopware6.json"

# This causes the "Authorization: Bearer <access_token>" header to be added.
CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

# Note: If you get a 401 response status code, then fetch a new access token and retry.
set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://my-shopware-6-shop.de/api/v3/search/category" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonToken
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [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.
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonToken
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    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": [
#   ]
# }

set numSearchResults [CkJsonObject_SizeOfArray $jResp "data"]
if {$numSearchResults != 1} then {
    puts "numSearchResults = $numSearchResults"
    puts "Did not find the category, or unexpectedly found more than one with the same name."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkJsonObject $jsonToken
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

set categoryId [CkJsonObject_stringOf $jResp "data[0].id"]

puts "Category ID = $categoryId"

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkJsonObject $jsonToken
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp