Visual Basic 6.0
Visual Basic 6.0
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.Chilkat Visual Basic 6.0 Downloads
Dim success As Long
success = 0
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
' 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 ChilkatHttpRequest
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 ChilkatJsonObject
success = json.UpdateString("idempotency_key","528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
success = json.UpdateString("object_id","2PTZYUOFGGDMT75UZLHQAPAC")
success = json.UpdateString("image.id","#TEMP_ID")
success = json.UpdateString("image.type","IMAGE")
success = 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 ChilkatHttpResponse
success = http.HttpSReq("connect.squareupsandbox.com",443,1,req,resp)
If (success = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
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
' 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
imageType = jResp.StringOf("image.type")
Dim imageId As String
imageId = jResp.StringOf("image.id")
Dim imageUpdated_at As String
imageUpdated_at = jResp.StringOf("image.updated_at")
Dim imageVersion As Long
imageVersion = jResp.IntOf("image.version")
Dim imageIs_deleted As Long
imageIs_deleted = jResp.BoolOf("image.is_deleted")
Dim imagePresent_at_all_locations As Long
imagePresent_at_all_locations = jResp.BoolOf("image.present_at_all_locations")
Dim imageImage_dataName As String
imageImage_dataName = jResp.StringOf("image.image_data.name")
Dim imageImage_dataUrl As String
imageImage_dataUrl = jResp.StringOf("image.image_data.url")
Dim imageImage_dataCaption As String
imageImage_dataCaption = jResp.StringOf("image.image_data.caption")