(Tcl) 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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# 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

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/v2/catalog/images"
CkHttpRequest_put_ContentType $req "multipart/form-data"
set success [CkHttpRequest_AddFileForUpload2 $req "file" "/local/path/to/file.jpg" "image/jpeg"]

# Make sure to use an object_id for an already-existing catalog item.
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "idempotency_key" "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86"
CkJsonObject_UpdateString $json "object_id" "2PTZYUOFGGDMT75UZLHQAPAC"
CkJsonObject_UpdateString $json "image.id" "#TEMP_ID"
CkJsonObject_UpdateString $json "image.type" "IMAGE"
CkJsonObject_UpdateString $json "image.image_data.caption" "A picture of a cup of coffee"

CkHttpRequest_AddParam $req "request" [CkJsonObject_emit $json]

CkHttpRequest_AddHeader $req "Expect" "100-continue"
CkHttpRequest_AddHeader $req "Authorization" "Bearer ACCESS_TOKEN"
CkHttpRequest_AddHeader $req "Accept" "application/json"
CkHttpRequest_AddHeader $req "Square-Version" "2020-07-22"

# This example uses the sandbox: connect.squareupsandbox.com
# Production should use connect.squareup.com
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "connect.squareupsandbox.com" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set imageType [CkJsonObject_stringOf $jResp "image.type"]
set imageId [CkJsonObject_stringOf $jResp "image.id"]
set imageUpdated_at [CkJsonObject_stringOf $jResp "image.updated_at"]
set imageVersion [CkJsonObject_IntOf $jResp "image.version"]
set imageIs_deleted [CkJsonObject_BoolOf $jResp "image.is_deleted"]
set imagePresent_at_all_locations [CkJsonObject_BoolOf $jResp "image.present_at_all_locations"]
set imageImage_dataName [CkJsonObject_stringOf $jResp "image.image_data.name"]
set imageImage_dataUrl [CkJsonObject_stringOf $jResp "image.image_data.url"]
set imageImage_dataCaption [CkJsonObject_stringOf $jResp "image.image_data.caption"]

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp