Swift

Shopware 6 - Delete Category

See more Shopware 6 Examples

Delete a category by name. Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

    // 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

    let json = CkoJsonObject()!
    json.updateString(jsonPath: "filter[0].type", value: "equals")
    json.updateString(jsonPath: "filter[0].field", value: "name")
    json.updateString(jsonPath: "filter[0].value", value: "Test123")
    json.updateString(jsonPath: "includes.category[0]", value: "id")
    json.updateString(jsonPath: "includes.category[1]", value: "name")

    // Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
    let jsonToken = CkoJsonObject()!
    jsonToken.loadFile(path: "qa_data/tokens/shopware6.json")

    // This causes the "Authorization: Bearer <access_token>" header to be added.
    http.authToken = jsonToken.string(of: "access_token")

    // Note: If you get a 401 response status code, then fetch a new access token and retry.
    let resp = CkoHttpResponse()!
    success = http.httpJson(verb: "POST", url: "https://my-shopware-6-shop.de/api/v3/search/category", json: json, contentType: "application/json", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp.getBodySb(sb: sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sb: sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    var respStatusCode: Int = resp.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp.header!)")
        print("Failed.")
        return
    }

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

    var numSearchResults: Int = jResp.size(ofArray: "data").intValue
    if numSearchResults != 1 {
        print("numSearchResults = \(numSearchResults)")
        print("Did not find the category, or unexpectedly found more than one with the same name.")
        return
    }

    var categoryId: String? = jResp.string(of: "data[0].id")

    print("Category ID = \(categoryId!)")

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

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

    let sbUrl = CkoStringBuilder()!
    sbUrl.append(value: "https://my-shopware-6-shop.de/api/v3/category/")
    sbUrl.append(value: categoryId)

    // If successful (204 response code), then the jsonStr will be empty.
    // Otherwise it will be a JSON error message.
    var jsonStr: String? = http.quickDeleteStr(url: sbUrl.getAsString())
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    // A 204 status code indicates success.
    respStatusCode = http.lastStatus.intValue
    print("Response status code for DELETE: \(respStatusCode)")

    // This will be non-empty if an error occurred.
    print("\(jsonStr!)")

}