PureBasic
PureBasic
Shopware 6 - Delete Category
See more Shopware 6 Examples
Delete a category by name.Chilkat PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
success.i = 0
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"filter[0].type","equals")
CkJsonObject::ckUpdateString(json,"filter[0].field","name")
CkJsonObject::ckUpdateString(json,"filter[0].value","Test123")
CkJsonObject::ckUpdateString(json,"includes.category[0]","id")
CkJsonObject::ckUpdateString(json,"includes.category[1]","name")
; Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/shopware6.json")
; This causes the "Authorization: Bearer <access_token>" header to be added.
CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))
; Note: If you get a 401 response status code, then fetch a new access token and retry.
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://my-shopware-6-shop.de/api/v3/search/category",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkJsonObject::ckDispose(jsonToken)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
; If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkJsonObject::ckDispose(jsonToken)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckSizeOfArray(jResp,"data")
If numSearchResults <> 1
Debug "numSearchResults = " + Str(numSearchResults)
Debug "Did not find the category, or unexpectedly found more than one with the same name."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkJsonObject::ckDispose(jsonToken)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
categoryId.s = CkJsonObject::ckStringOf(jResp,"data[0].id")
Debug "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.i = CkStringBuilder::ckCreate()
If sbUrl.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbUrl,"https://my-shopware-6-shop.de/api/v3/category/")
CkStringBuilder::ckAppend(sbUrl,categoryId)
; If successful (204 response code), then the jsonStr will be empty.
; Otherwise it will be a JSON error message.
jsonStr.s = CkHttp::ckQuickDeleteStr(http,CkStringBuilder::ckGetAsString(sbUrl))
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkJsonObject::ckDispose(jsonToken)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
CkStringBuilder::ckDispose(sbUrl)
ProcedureReturn
EndIf
; A 204 status code indicates success.
respStatusCode = CkHttp::ckLastStatus(http)
Debug "Response status code for DELETE: " + Str(respStatusCode)
; This will be non-empty if an error occurred.
Debug jsonStr
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkJsonObject::ckDispose(jsonToken)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
CkStringBuilder::ckDispose(sbUrl)
ProcedureReturn
EndProcedure