(Excel) Shopware 6 - Find Product by Name

See more Shopware 6 Examples

Find a product with a given name and get the id.

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Sends the following POST to find the product named "Test123"

' POST /api/v3/search/product
' {
'     "filter": [
'         { "type": "equals", "field": "name", "value": "Test123" }
'     ],
'     "includes": {
'         "product": ["id", "name"]
'     }
' }

' Create the above JSON.
' Use this online tool to generate code from sample JSON:
' Generate Code to Create JSON

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.UpdateString("filter[0].type","equals")
success = json.UpdateString("filter[0].field","name")
success = json.UpdateString("filter[0].value","Test123")
success = json.UpdateString("includes.product[0]","id")
success = json.UpdateString("includes.product[1]","name")
' 

' Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
success = jsonToken.LoadFile("qa_data/tokens/shopware6.json")

' This causes the "Authorization: Bearer <access_token>" header to be added.
http.AuthToken = jsonToken.StringOf("access_token")

' Note: If you get a 401 response status code, then fetch a new access token and retry.

Set resp = http.PostJson3("https://my-shopware-6-shop.de/api/v3/search/product","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.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.

respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' The response looks like this:
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON

' {
'   "data": [
'     {
'       "id": "d195dabb53cf46d096bd9a8726d82558",
'       "type": "product",
'       "attributes": {
'         "name": "Test123",
'         "apiAlias": null
'       },
'       "links": {
'         "self": "https:\/\/***.de\/api\/v3\/product\/d195dabb53cf46d096bd9a8726d82558"
'       },
'       "relationships": [
'       ],
'       "meta": null
'     }
'   ],
'   "included": [
'   ],
'   "links": {
'     "self": "https:\/\/***.de\/api\/v3\/search\/product"
'   },
'   "meta": {
'     "totalCountMode": 0,
'     "total": 1
'   },
'   "aggregations": [
'   ]
' }


numSearchResults = jResp.SizeOfArray("data")
If (numSearchResults <> 1) Then
    Debug.Print "numSearchResults = "; numSearchResults
    Debug.Print "Did not find the product, or unexpectedly found more than one with the same name."
    Exit Sub
End If


productId = jResp.StringOf("data[0].id")

Debug.Print "Product ID = "; productId