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

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

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

loJson = createobject("CkJsonObject")
loJson.UpdateString("includes.category[0]","id")
loJson.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.
loHttp.SetRequestHeader("sw-access-key","<sales-channel-api-access-key>")

loResp = loHttp.PostJson3("https://my-shopware-6-shop.de/store-api/v3/category","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    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 loSbResponseBody
    release loJResp
    return
endif

release loResp

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

lnTotal = loJResp.IntOf("total")
lcApiAlias = loJResp.StringOf("apiAlias")
i = 0
lnCount_i = loJResp.SizeOfArray("elements")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("elements[i].id")
    lcName = loJResp.StringOf("elements[i].name")
    lcApiAlias = loJResp.StringOf("elements[i].apiAlias")
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp