PowerShell

Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.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

$json = New-Object Chilkat.JsonObject
$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 = New-Object Chilkat.JsonObject
$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.
$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpJson("POST","https://my-shopware-6-shop.de/api/v3/search/category",$json,"application/json",$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($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
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")
    exit
}

# 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 -ne 1) {
    $("numSearchResults = " + $numSearchResults)
    $("Did not find the category, or unexpectedly found more than one with the same name.")
    exit
}

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

$("Category ID = " + $categoryId)

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

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

$sbUrl = New-Object Chilkat.StringBuilder
$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.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

# A 204 status code indicates success.
$respStatusCode = $http.LastStatus
$("Response status code for DELETE: " + $respStatusCode)

# This will be non-empty if an error occurred.
$($jsonStr)