(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.UpdateString("includes.category[0]","id")
success = 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.
http.SetRequestHeader "sw-access-key","<sales-channel-api-access-key>"


Set resp = http.PostJson3("https://my-shopware-6-shop.de/store-api/v3/category","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.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.

respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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


total = jResp.IntOf("total")

apiAlias = jResp.StringOf("apiAlias")

i = 0

count_i = jResp.SizeOfArray("elements")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("elements[i].id")
    name = jResp.StringOf("elements[i].name")
    apiAlias = jResp.StringOf("elements[i].apiAlias")
    i = i + 1
Loop