(PureBasic) Shopware 6 - List Categories

See more Shopware 6 Examples

Get a list of categories.

For more information, see https://docs.shopware.com/en/shopware-platform-dev-en/store-api-guide/navigation?category=shopware-platform-dev-en/store-api-guide

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; 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

    success.i

    ; Sends the following POST

    ; POST /store-api/v3/category
    ; {
    ;     "includes": {
    ;         "category": ["id", "name"]
    ;     }
    ; }

    ; 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,"includes.category[0]","id")
    CkJsonObject::ckUpdateString(json,"includes.category[1]","name")

    ; This request simply authenticate with the sw-access-key you can interactively copy from your 
    ; sales channel in the Shopware 6 administration web portal.

    

    ; We do NOT use OAuth2 for Store API requests.
    CkHttp::ckSetRequestHeader(http,"sw-access-key","<sales-channel-api-access-key>")

    resp.i = CkHttp::ckPostJson3(http,"https://my-shopware-6-shop.de/store-api/v3/category","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        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."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "total": 2,
    ;   "aggregations": [],
    ;   "elements": [
    ;     {
    ;       "id": "00a284072bcb42ed8fee31e26ea53b60",
    ;       "name": "Home",
    ;       "apiAlias": "category"
    ;     },
    ;     {
    ;       "id": "bd835e75afa14b09b7da156d095a9a30",
    ;       "name": "Outdoors",
    ;       "apiAlias": "category"
    ;     }
    ;   ],
    ;   "apiAlias": "dal_entity_search_result"
    ; }

    ; Sample code for parsing the JSON response...
    ; Use the following online tool to generate parsing code from sample JSON:
    ; Generate Parsing Code from JSON

    id.s
    name.s

    total.i = CkJsonObject::ckIntOf(jResp,"total")
    apiAlias.s = CkJsonObject::ckStringOf(jResp,"apiAlias")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"elements")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"elements[i].id")
        name = CkJsonObject::ckStringOf(jResp,"elements[i].name")
        apiAlias = CkJsonObject::ckStringOf(jResp,"elements[i].apiAlias")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure