Lua

Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

local chilkat = require("chilkat")

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

local http = chilkat.Http.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

local json = chilkat.JsonObject.new()
json:update_string("filter[0].type", "equals")
json:update_string("filter[0].field", "name")
json:update_string("filter[0].value", "Test123")
json:update_string("includes.category[0]", "id")
json:update_string("includes.category[1]", "name")

-- Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
local jsonToken = chilkat.JsonObject.new()
jsonToken:load_file("qa_data/tokens/shopware6.json")

-- This causes the "Authorization: Bearer <access_token>" header to be added.
http.auth_token = jsonToken:string_of("access_token")

-- Note: If you get a 401 response status code, then fetch a new access token and retry.
local resp = chilkat.HttpResponse.new()
local success = http:http_json("POST", "https://my-shopware-6-shop.de/api/v3/search/category", json, "application/json", resp)
if not success then
    print(http.last_error_text)
    return
end

local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

-- If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
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": [
--   ]
-- }

local numSearchResults = jResp:size_of_array("data")
if numSearchResults ~= 1 then
    print("numSearchResults = " .. numSearchResults)
    print("Did not find the category, or unexpectedly found more than one with the same name.")
    return
end

local categoryId = jResp:string_of("data[0].id")

print("Category ID = " .. categoryId)