VB.NET

Shopware 6 - Find Product by Name

See more Shopware 6 Examples

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

Dim success As Boolean = False

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

Dim http As New Chilkat.Http

' 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 New Chilkat.JsonObject
json.UpdateString("filter[0].type","equals")
json.UpdateString("filter[0].field","name")
json.UpdateString("filter[0].value","Test123")
json.UpdateString("includes.product[0]","id")
json.UpdateString("includes.product[1]","name")
' 

' Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
Dim jsonToken As New Chilkat.JsonObject
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.
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST","https://my-shopware-6-shop.de/api/v3/search/product",json,"application/json",resp)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

' If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("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": [
'   ]
' }

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


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

Debug.WriteLine("Product ID = " & productId)