(Excel) Square API - Create Catalog Image

Uploads an image file to be represented by an CatalogImage object linked to an existing CatalogObject instance.

For more information, see https://developer.squareup.com/reference/square/catalog-api/create-catalog-image

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

' 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 Chilkat.HttpRequest
Set req = Chilkat.NewHttpRequest
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 Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
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

Set resp = http.SynchronousRequest("connect.squareupsandbox.com",443,True,req)
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()


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


imageType = jResp.StringOf("image.type")

imageId = jResp.StringOf("image.id")

imageUpdated_at = jResp.StringOf("image.updated_at")

imageVersion = jResp.IntOf("image.version")

imageIs_deleted = jResp.BoolOf("image.is_deleted")

imagePresent_at_all_locations = jResp.BoolOf("image.present_at_all_locations")

imageImage_dataName = jResp.StringOf("image.image_data.name")

imageImage_dataUrl = jResp.StringOf("image.image_data.url")

imageImage_dataCaption = jResp.StringOf("image.image_data.caption")