(PowerBuilder) Shopware 6 - Find Category by Name

See more Shopware 6 Examples

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_JsonToken
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_NumSearchResults
string ls_CategoryId

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

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

// Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")

loo_JsonToken.LoadFile("qa_data/tokens/shopware6.json")

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

// Note: If you get a 401 response status code, then fetch a new access token and retry.
loo_Resp = loo_Http.PostJson3("https://my-shopware-6-shop.de/api/v3/search/category","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_JsonToken
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_Json
    destroy loo_JsonToken
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

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

li_NumSearchResults = loo_JResp.SizeOfArray("data")
if li_NumSearchResults <> 1 then
    Write-Debug "numSearchResults = " + string(li_NumSearchResults)
    Write-Debug "Did not find the category, or unexpectedly found more than one with the same name."
    destroy loo_Http
    destroy loo_Json
    destroy loo_JsonToken
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

ls_CategoryId = loo_JResp.StringOf("data[0].id")

Write-Debug "Category ID = " + ls_CategoryId


destroy loo_Http
destroy loo_Json
destroy loo_JsonToken
destroy loo_SbResponseBody
destroy loo_JResp