VB.NET

Square API - Create Catalog Image

See more Square Examples

Uploads an image file to be represented by an CatalogImage object linked to an existing CatalogObject instance. 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

' Implements the following CURL command:

' curl https://connect.squareup.com/v2/catalog/images \
'   -X POST \
'   -H 'Square-Version: 2020-07-22' \
'   -H 'Authorization: Bearer ACCESS_TOKEN' \
'   -H 'Accept: application/json' \
'   -F 'file=@/local/path/to/file.jpg' \
'   -F 'request={
'     "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
'     "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
'     "image": {
'       "id": "#TEMP_ID",
'       "type": "IMAGE",
'       "image_data": {
'         "caption": "A picture of a cup of coffee"
'       }
'     }
'   }'

' Use the following online tool to generate HTTP code from a CURL command
' Convert a cURL Command to HTTP Source Code

Dim req As New Chilkat.HttpRequest
req.HttpVerb = "POST"
req.Path = "/v2/catalog/images"
req.ContentType = "multipart/form-data"
success = req.AddFileForUpload2("file","/local/path/to/file.jpg","image/jpeg")

' Make sure to use an object_id for an already-existing catalog item.
Dim json As New Chilkat.JsonObject
json.UpdateString("idempotency_key","528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
json.UpdateString("object_id","2PTZYUOFGGDMT75UZLHQAPAC")
json.UpdateString("image.id","#TEMP_ID")
json.UpdateString("image.type","IMAGE")
json.UpdateString("image.image_data.caption","A picture of a cup of coffee")

req.AddParam("request",json.Emit())

req.AddHeader("Expect","100-continue")
req.AddHeader("Authorization","Bearer ACCESS_TOKEN")
req.AddHeader("Accept","application/json")
req.AddHeader("Square-Version","2020-07-22")

' This example uses the sandbox: connect.squareupsandbox.com
' Production should use connect.squareup.com
Dim resp As New Chilkat.HttpResponse
success = http.HttpSReq("connect.squareupsandbox.com",443,True,req,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())

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


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

' {
'   "image": {
'     "type": "IMAGE",
'     "id": "UBXKMBQ4QK47QXMNQD6ELCZT",
'     "updated_at": "2020-08-07T15:20:09.779Z",
'     "version": 1596813609779,
'     "is_deleted": false,
'     "present_at_all_locations": true,
'     "image_data": {
'       "name": "",
'       "url": "https://square-catalog-sandbox.s3.amazonaws.com/files/168973eab6f8b39b5cbdad52e3f82b23be196e2b/original.jpeg",
'       "caption": "A picture of a cup of coffee"
'     }
'   }
' }

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



Dim imageType As String = jResp.StringOf("image.type")
Dim imageId As String = jResp.StringOf("image.id")
Dim imageUpdated_at As String = jResp.StringOf("image.updated_at")
Dim imageVersion As Integer = jResp.IntOf("image.version")
Dim imageIs_deleted As Boolean = jResp.BoolOf("image.is_deleted")
Dim imagePresent_at_all_locations As Boolean = jResp.BoolOf("image.present_at_all_locations")
Dim imageImage_dataName As String = jResp.StringOf("image.image_data.name")
Dim imageImage_dataUrl As String = jResp.StringOf("image.image_data.url")
Dim imageImage_dataCaption As String = jResp.StringOf("image.image_data.caption")