(Ruby) Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# First, let's search for the category by name because we'll need to know the category's id to delete.

# Sends the following POST

# 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

json = Chilkat::CkJsonObject.new()
json.UpdateString("filter[0].type","equals")
json.UpdateString("filter[0].field","name")
json.UpdateString("filter[0].value","Test123")
json.UpdateString("includes.category[0]","id")
json.UpdateString("includes.category[1]","name")

# Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
jsonToken = Chilkat::CkJsonObject.new()
jsonToken.LoadFile("qa_data/tokens/shopware6.json")

# This causes the "Authorization: Bearer <access_token>" header to be added.
http.put_AuthToken(jsonToken.stringOf("access_token"))

# Note: If you get a 401 response status code, then fetch a new access token and retry.
# resp is a CkHttpResponse
resp = http.PostJson3("https://my-shopware-6-shop.de/api/v3/search/category","application/json",json)
if (http.get_LastMethodSuccess() == 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

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

numSearchResults = jResp.SizeOfArray("data")
if (numSearchResults != 1)
    print "numSearchResults = " + numSearchResults.to_s() + "\n";
    print "Did not find the category, or unexpectedly found more than one with the same name." + "\n";
    exit
end

categoryId = jResp.stringOf("data[0].id")

print "Category ID = " + categoryId + "\n";

# -----------------------------------------------------------------------------------------------
# Delete this category by the given ID.

# We need to send a DELETE request like this:
# DELETE /api/v3/category/5840ff0975ac428ebf7838359e47737f

sbUrl = Chilkat::CkStringBuilder.new()
sbUrl.Append("https://my-shopware-6-shop.de/api/v3/category/")
sbUrl.Append(categoryId)

# If successful (204 response code), then the jsonStr will be empty.
# Otherwise it will be a JSON error message.
jsonStr = http.quickDeleteStr(sbUrl.getAsString())
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

# A 204 status code indicates success.
respStatusCode = http.get_LastStatus()
print "Response status code for DELETE: " + respStatusCode.to_s() + "\n";

# This will be non-empty if an error occurred.
print jsonStr + "\n";