Chilkat2-Python
Chilkat2-Python
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 Chilkat2-Python Downloads
import sys
import chilkat2
success = False
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.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
req = chilkat2.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.
json = chilkat2.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
resp = chilkat2.HttpResponse()
success = http.HttpSReq("connect.squareupsandbox.com",443,True,req,resp)
if (success == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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")