(Lianja) Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("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

loJson = createobject("CkJsonObject")
loJson.UpdateString("filter[0].type","equals")
loJson.UpdateString("filter[0].field","name")
loJson.UpdateString("filter[0].value","Test123")
loJson.UpdateString("includes.category[0]","id")
loJson.UpdateString("includes.category[1]","name")

// Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/shopware6.json")

// This causes the "Authorization: Bearer <access_token>" header to be added.
loHttp.AuthToken = loJsonToken.StringOf("access_token")

// Note: If you get a 401 response status code, then fetch a new access token and retry.
loResp = loHttp.PostJson3("https://my-shopware-6-shop.de/api/v3/search/category","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loJsonToken
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loJsonToken
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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": [
//   ]
// }

lnNumSearchResults = loJResp.SizeOfArray("data")
if (lnNumSearchResults <> 1) then
    ? "numSearchResults = " + str(lnNumSearchResults)
    ? "Did not find the category, or unexpectedly found more than one with the same name."
    release loHttp
    release loJson
    release loJsonToken
    release loSbResponseBody
    release loJResp
    return
endif

lcCategoryId = loJResp.StringOf("data[0].id")

? "Category ID = " + lcCategoryId


release loHttp
release loJson
release loJsonToken
release loSbResponseBody
release loJResp