(PowerBuilder) Shopware 6 - List Categories

See more Shopware 6 Examples

Get a list of categories.

For more information, see https://docs.shopware.com/en/shopware-platform-dev-en/store-api-guide/navigation?category=shopware-platform-dev-en/store-api-guide

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_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
integer li_Total
string ls_ApiAlias
integer i
integer li_Count_i

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

// POST /store-api/v3/category
// {
//     "includes": {
//         "category": ["id", "name"]
//     }
// }

// 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("includes.category[0]","id")
loo_Json.UpdateString("includes.category[1]","name")

// This request simply authenticate with the sw-access-key you can interactively copy from your 
// sales channel in the Shopware 6 administration web portal.



// We do NOT use OAuth2 for Store API requests.
loo_Http.SetRequestHeader("sw-access-key","<sales-channel-api-access-key>")

loo_Resp = loo_Http.PostJson3("https://my-shopware-6-shop.de/store-api/v3/category","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    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_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "total": 2,
//   "aggregations": [],
//   "elements": [
//     {
//       "id": "00a284072bcb42ed8fee31e26ea53b60",
//       "name": "Home",
//       "apiAlias": "category"
//     },
//     {
//       "id": "bd835e75afa14b09b7da156d095a9a30",
//       "name": "Outdoors",
//       "apiAlias": "category"
//     }
//   ],
//   "apiAlias": "dal_entity_search_result"
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

li_Total = loo_JResp.IntOf("total")
ls_ApiAlias = loo_JResp.StringOf("apiAlias")
i = 0
li_Count_i = loo_JResp.SizeOfArray("elements")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Id = loo_JResp.StringOf("elements[i].id")
    ls_Name = loo_JResp.StringOf("elements[i].name")
    ls_ApiAlias = loo_JResp.StringOf("elements[i].apiAlias")
    i = i + 1
loop


destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp