(Tcl) Shopware 6 - List Products

See more Shopware 6 Examples

Get a list of products.

For more information, see https://docs.shopware.com/en/shopware-platform-dev-en/store-api-guide/products

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Sends the following POST

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

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "includes.product[0]" "id"
CkJsonObject_UpdateString $json "includes.product[1]" "name"

# This request simply authenticates 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_SetRequestHeader $http "sw-access-key" "<sales-channel-api-access-key>"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://my-shopware-6-shop.de/store-api/v3/product" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

# If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "total": 2,
#   "aggregations": [],
#   "elements": [
#     {
#       "id": "00a284072bcb42ed8fee31e26ea53b60",
#       "name": "Synergistic Wooden Coffee Patch",
#       "apiAlias": "product"
#     },
#     {
#       "id": "bd835e75afa14b09b7da156d095a9a30",
#       "name": "Intelligent Cotton Presto Pesto",
#       "apiAlias": "product"
#     }
#   ],
#   "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

set total [CkJsonObject_IntOf $jResp "total"]
set apiAlias [CkJsonObject_stringOf $jResp "apiAlias"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "elements"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "elements[i].id"]
    set name [CkJsonObject_stringOf $jResp "elements[i].name"]
    set apiAlias [CkJsonObject_stringOf $jResp "elements[i].apiAlias"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp