SQL Server
SQL Server
Shopware 6 - Delete Category
See more Shopware 6 Examples
Delete a category by name.Chilkat SQL Server Downloads
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- 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
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter[0].type', 'equals'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter[0].field', 'name'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'filter[0].value', 'Test123'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.category[0]', 'id'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.category[1]', 'name'
-- Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
DECLARE @jsonToken int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/shopware6.json'
-- This causes the "Authorization: Bearer <access_token>" header to be added.
EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
EXEC sp_OASetProperty @http, 'AuthToken', @sTmp0
-- Note: If you get a 401 response status code, then fetch a new access token and retry.
DECLARE @resp int
EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT
EXEC sp_OAMethod @http, 'HttpJson', @success OUT, 'POST', 'https://my-shopware-6-shop.de/api/v3/search/category', @json, 'application/json', @resp
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @resp
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
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": [
-- ]
-- }
DECLARE @numSearchResults int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @numSearchResults OUT, 'data'
IF @numSearchResults <> 1
BEGIN
PRINT 'numSearchResults = ' + @numSearchResults
PRINT 'Did not find the category, or unexpectedly found more than one with the same name.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
DECLARE @categoryId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @categoryId OUT, '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
DECLARE @sbUrl int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbUrl OUT
EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, 'https://my-shopware-6-shop.de/api/v3/category/'
EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, @categoryId
-- If successful (204 response code), then the jsonStr will be empty.
-- Otherwise it will be a JSON error message.
DECLARE @jsonStr nvarchar(4000)
EXEC sp_OAMethod @sbUrl, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @http, 'QuickDeleteStr', @jsonStr OUT, @sTmp0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
EXEC @hr = sp_OADestroy @sbUrl
RETURN
END
-- A 204 status code indicates success.
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response status code for DELETE: ' + @respStatusCode
-- This will be non-empty if an error occurred.
PRINT @jsonStr
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @jsonToken
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
EXEC @hr = sp_OADestroy @sbUrl
END
GO