Ruby

Shopware 6 - List Categories

See more Shopware 6 Examples

Get a list of categories. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

#  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

json = Chilkat::CkJsonObject.new()
json.UpdateString("includes.category[0]","id")
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>")

resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://my-shopware-6-shop.de/store-api/v3/category",json,"application/json",resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

#  If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";
    exit
end

#  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")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("elements[i].id")
    name = jResp.stringOf("elements[i].name")
    apiAlias = jResp.stringOf("elements[i].apiAlias")
    i = i + 1
end