(Tcl) Upsert Catalog Object

Creates or updates the target CatalogObject.

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

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/object \
#   -X POST \
#   -H 'Square-Version: 2020-07-22' \
#   -H 'Authorization: Bearer ACCESS_TOKEN' \
#   -H 'Content-Type: application/json' \
#   -d '{
#     "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
#     "object": {
#       "type": "ITEM",
#       "id": "#Cocoa",
#       "item_data": {
#         "name": "Cocoa",
#         "description": "Hot chocolate",
#         "abbreviation": "Ch"
#       }
#     }
#   }'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
#   "object": {
#     "type": "ITEM",
#     "id": "#Cocoa",
#     "item_data": {
#       "name": "Cocoa",
#       "description": "Hot chocolate",
#       "abbreviation": "Ch"
#     }
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "idempotency_key" "af3d1afc-7212-4300-b463-0bfc5314a5ae"
CkJsonObject_UpdateString $json "object.type" "ITEM"
CkJsonObject_UpdateString $json "object.id" "#Cocoa"
CkJsonObject_UpdateString $json "object.item_data.name" "Cocoa"
CkJsonObject_UpdateString $json "object.item_data.description" "Hot chocolate"
CkJsonObject_UpdateString $json "object.item_data.abbreviation" "Ch"

# Adds the "Authorization: Bearer ACCESS_TOKEN" header.
CkHttp_put_AuthToken $http "ACCESS_TOKEN"
CkHttp_SetRequestHeader $http "Square-Version" "2020-07-22"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# This example uses the sandbox: connect.squareupsandbox.com
# Production should use connect.squareup.com
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://connect.squareupsandbox.com/v2/catalog/object" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    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_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)

# {
#   "catalog_object": {
#     "type": "ITEM",
#     "id": "7SB3ZQYJ5GDMVFL7JK46JCHT",
#     "updated_at": "2016-11-16T22:32:42.996Z",
#     "version": 1479335562996,
#     "is_deleted": false,
#     "item_data": {
#       "name": "Cocoa",
#       "description": "Hot chocolate",
#       "abbreviation": "Ch"
#     }
#   },
#   "id_mappings": [
#     {
#       "client_object_id": "#Cocoa",
#       "object_id": "7SB3ZQYJ5GDMVFL7JK46JCHT"
#     }
#   ]
# }

# 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 catalog_objectType [CkJsonObject_stringOf $jResp "catalog_object.type"]
set catalog_objectId [CkJsonObject_stringOf $jResp "catalog_object.id"]
set catalog_objectUpdated_at [CkJsonObject_stringOf $jResp "catalog_object.updated_at"]
set catalog_objectVersion [CkJsonObject_IntOf $jResp "catalog_object.version"]
set catalog_objectIs_deleted [CkJsonObject_BoolOf $jResp "catalog_object.is_deleted"]
set catalog_objectItem_dataName [CkJsonObject_stringOf $jResp "catalog_object.item_data.name"]
set catalog_objectItem_dataDescription [CkJsonObject_stringOf $jResp "catalog_object.item_data.description"]
set catalog_objectItem_dataAbbreviation [CkJsonObject_stringOf $jResp "catalog_object.item_data.abbreviation"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "id_mappings"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set client_object_id [CkJsonObject_stringOf $jResp "id_mappings[i].client_object_id"]
    set object_id [CkJsonObject_stringOf $jResp "id_mappings[i].object_id"]
    set i [expr $i + 1]
}

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