Lianja
Lianja
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 Lianja Downloads
llSuccess = .F.
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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
loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.Path = "/v2/catalog/images"
loReq.ContentType = "multipart/form-data"
llSuccess = loReq.AddFileForUpload2("file","/local/path/to/file.jpg","image/jpeg")
// Make sure to use an object_id for an already-existing catalog item.
loJson = createobject("CkJsonObject")
loJson.UpdateString("idempotency_key","528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
loJson.UpdateString("object_id","2PTZYUOFGGDMT75UZLHQAPAC")
loJson.UpdateString("image.id","#TEMP_ID")
loJson.UpdateString("image.type","IMAGE")
loJson.UpdateString("image.image_data.caption","A picture of a cup of coffee")
loReq.AddParam("request",loJson.Emit())
loReq.AddHeader("Expect","100-continue")
loReq.AddHeader("Authorization","Bearer ACCESS_TOKEN")
loReq.AddHeader("Accept","application/json")
loReq.AddHeader("Square-Version","2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpSReq("connect.squareupsandbox.com",443,.T.,loReq,loResp)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loReq
release loJson
release loResp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loHttp
release loReq
release loJson
release loResp
release loSbResponseBody
release loJResp
return
endif
// 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
lcImageType = loJResp.StringOf("image.type")
lcImageId = loJResp.StringOf("image.id")
lcImageUpdated_at = loJResp.StringOf("image.updated_at")
lnImageVersion = loJResp.IntOf("image.version")
llImageIs_deleted = loJResp.BoolOf("image.is_deleted")
llImagePresent_at_all_locations = loJResp.BoolOf("image.present_at_all_locations")
lcImageImage_dataName = loJResp.StringOf("image.image_data.name")
lcImageImage_dataUrl = loJResp.StringOf("image.image_data.url")
lcImageImage_dataCaption = loJResp.StringOf("image.image_data.caption")
release loHttp
release loReq
release loJson
release loResp
release loSbResponseBody
release loJResp