Xbase++

Shopware 6 - Find Category by Name

See more Shopware 6 Examples

Find a category with a given name and get the id. Xbase++

LOCAL nSuccess
LOCAL oHttp
LOCAL oJson
LOCAL oJsonToken
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL nNumSearchResults
LOCAL cCategoryId

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

//  Sends the following POST to find the category named "Test123"

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

oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("filter[0].type", "equals")
oJson:UpdateString("filter[0].field", "name")
oJson:UpdateString("filter[0].value", "Test123")
oJson:UpdateString("includes.category[0]", "id")
oJson:UpdateString("includes.category[1]", "name")

//  Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
oJsonToken := CreateObject("Chilkat.JsonObject")
oJsonToken:LoadFile("qa_data/tokens/shopware6.json")

//  This causes the "Authorization: Bearer <access_token>" header to be added.
oHttp:AuthToken := oJsonToken:StringOf("access_token")

//  Note: If you get a 401 response status code, then fetch a new access token and retry.
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", "https://my-shopware-6-shop.de/api/v3/search/category", oJson, "application/json", oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oJson:destroy()
    oJsonToken:destroy()
    oResp:destroy()
    RETURN
ENDIF

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

//  If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oResp:Header
    ? "Failed."
    oHttp:destroy()
    oJson:destroy()
    oJsonToken:destroy()
    oResp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
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": [
//    ]
//  }

nNumSearchResults := oJResp:SizeOfArray("data")
IF (nNumSearchResults != 1)
    ? "numSearchResults = " + Str(nNumSearchResults)
    ? "Did not find the category, or unexpectedly found more than one with the same name."
    oHttp:destroy()
    oJson:destroy()
    oJsonToken:destroy()
    oResp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
ENDIF

cCategoryId := oJResp:StringOf("data[0].id")

? "Category ID = " + cCategoryId

oHttp:destroy()
oJson:destroy()
oJsonToken:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()