(Tcl) Square API - List Catalog

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog.

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

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/list?types=category%2Ctax \
#   -H 'Square-Version: 2020-07-22' \
#   -H 'Authorization: Bearer ACCESS_TOKEN' \
#   -H 'Content-Type: application/json'

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

# 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
set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

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

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "objects": [
#     {
#       "type": "CATEGORY",
#       "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
#       "updated_at": "2017-02-21T14:50:26.495Z",
#       "version": 1487688626495,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "category_data": {
#         "name": "Beverages"
#       }
#     },
#     {
#       "type": "TAX",
#       "id": "L5R47DGBZOOVKCAFIXC56AEN",
#       "updated_at": "2017-02-21T14:50:26.495Z",
#       "version": 1487688626495,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "tax_data": {
#         "name": "Sales Tax",
#         "calculation_phase": "TAX_SUBTOTAL_PHASE",
#         "inclusion_type": "ADDITIVE",
#         "percentage": "5.0",
#         "enabled": true
#       }
#     }
#   ]
# }

# 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 i 0
set count_i [CkJsonObject_SizeOfArray $jResp "objects"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_type [CkJsonObject_stringOf $jResp "objects[i].type"]
    set id [CkJsonObject_stringOf $jResp "objects[i].id"]
    set updated_at [CkJsonObject_stringOf $jResp "objects[i].updated_at"]
    set version [CkJsonObject_IntOf $jResp "objects[i].version"]
    set is_deleted [CkJsonObject_BoolOf $jResp "objects[i].is_deleted"]
    set present_at_all_locations [CkJsonObject_BoolOf $jResp "objects[i].present_at_all_locations"]
    set category_dataName [CkJsonObject_stringOf $jResp "objects[i].category_data.name"]
    set tax_dataName [CkJsonObject_stringOf $jResp "objects[i].tax_data.name"]
    set tax_dataCalculation_phase [CkJsonObject_stringOf $jResp "objects[i].tax_data.calculation_phase"]
    set tax_dataInclusion_type [CkJsonObject_stringOf $jResp "objects[i].tax_data.inclusion_type"]
    set tax_dataPercentage [CkJsonObject_stringOf $jResp "objects[i].tax_data.percentage"]
    set tax_dataEnabled [CkJsonObject_BoolOf $jResp "objects[i].tax_data.enabled"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp