B4X

Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name. B4X

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("http")

'  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

Dim json As ChilkatJsonObject
json.Initialize
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
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/shopware6.json")

'  This causes the "Authorization: Bearer <access_token>" header to be added.
http.AuthToken = jsonToken.StringOf("access_token")

'  Note: If you get a 401 response status code, then fetch a new access token and retry.
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://my-shopware-6-shop.de/api/v3/search/category", json, "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Log("Response Body:")
Log(jResp.Emit)

'  If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(resp.Header)
    Log("Failed.")
    Return
End If


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

Dim numSearchResults As Int = jResp.SizeOfArray("data")
If numSearchResults <> 1 Then
    Log("numSearchResults = " & numSearchResults)
    Log("Did not find the category, or unexpectedly found more than one with the same name.")
    Return
End If


Dim categoryId As String = jResp.StringOf("data[0].id")

Log("Category ID = " & categoryId)

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

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

Dim sbUrl As ChilkatStringBuilder
sbUrl.Initialize
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.
Dim jsonStr As String = http.QuickDeleteStr(sbUrl.GetAsString)
If http.LastMethodSuccess = False Then
    Log(http.LastErrorText)
    Return
End If


'  A 204 status code indicates success.
respStatusCode = http.LastStatus
Log("Response status code for DELETE: " & respStatusCode)

'  This will be non-empty if an error occurred.
Log(jsonStr)