(Tcl) Square API - Search Catalog Objects

Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,

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

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/search \
#   -X POST \
#   -H 'Square-Version: 2020-07-22' \
#   -H 'Authorization: Bearer ACCESS_TOKEN' \
#   -H 'Content-Type: application/json' \
#   -d '{
#     "object_types": [
#       "ITEM"
#     ],
#     "query": {
#       "prefix_query": {
#         "attribute_name": "name",
#         "attribute_prefix": "tea"
#       }
#     },
#     "limit": 100
#   }'

# 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.

# {
#   "object_types": [
#     "ITEM"
#   ],
#   "query": {
#     "prefix_query": {
#       "attribute_name": "name",
#       "attribute_prefix": "tea"
#     }
#   },
#   "limit": 100
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "object_types[0]" "ITEM"
CkJsonObject_UpdateString $json "query.prefix_query.attribute_name" "name"
CkJsonObject_UpdateString $json "query.prefix_query.attribute_prefix" "tea"
CkJsonObject_UpdateInt $json "limit" 100

# 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/search" "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)

# {
#   "objects": [
#     {
#       "type": "ITEM",
#       "id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
#       "updated_at": "2017-10-26T15:41:32.337Z",
#       "version": 1509032492337,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "item_data": {
#         "name": "Tea - Black",
#         "description": "A delicious blend of black tea.",
#         "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
#         "product_type": "REGULAR",
#         "tax_ids": [
#           "ZXITPM6RWHZ7GZ7EIP3YKECM"
#         ],
#         "variations": [
#           {
#             "type": "ITEM_VARIATION",
#             "id": "5GSZPX6EU7MM75S57OONG3V5",
#             "updated_at": "2017-10-26T15:27:31.626Z",
#             "version": 1509031651626,
#             "is_deleted": false,
#             "present_at_all_locations": true,
#             "item_variation_data": {
#               "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
#               "name": "Regular",
#               "ordinal": 1,
#               "price_money": {
#                 "amount": 150,
#                 "currency": "USD"
#               },
#               "pricing_type": "FIXED_PRICING"
#             }
#           },
#           {
#             "type": "ITEM_VARIATION",
#             "id": "XVLBN7DU6JTWHJTG5F265B43",
#             "updated_at": "2017-10-26T15:27:31.626Z",
#             "version": 1509031651626,
#             "is_deleted": false,
#             "present_at_all_locations": true,
#             "item_variation_data": {
#               "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
#               "name": "Large",
#               "ordinal": 2,
#               "price_money": {
#                 "amount": 225,
#                 "currency": "USD"
#               },
#               "pricing_type": "FIXED_PRICING"
#             }
#           }
#         ],
#         "visibility": "PRIVATE"
#       }
#     },
#     {
#       "type": "ITEM",
#       "id": "NNNEM3LA656Q46NXLWCNI7S5",
#       "updated_at": "2017-10-26T15:41:23.232Z",
#       "version": 1509032483232,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "item_data": {
#         "name": "Tea - Green",
#         "description": "Relaxing green herbal tea.",
#         "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
#         "product_type": "REGULAR",
#         "tax_ids": [
#           "ZXITPM6RWHZ7GZ7EIP3YKECM"
#         ],
#         "variations": [
#           {
#             "type": "ITEM_VARIATION",
#             "id": "FHYBVIA6NVBCSOVETA62WEA4",
#             "updated_at": "2017-10-26T15:29:00.524Z",
#             "version": 1509031740524,
#             "is_deleted": false,
#             "present_at_all_locations": true,
#             "item_variation_data": {
#               "item_id": "NNNEM3LA656Q46NXLWCNI7S5",
#               "name": "Regular",
#               "ordinal": 1,
#               "price_money": {
#                 "amount": 150,
#                 "currency": "USD"
#               },
#               "pricing_type": "FIXED_PRICING"
#             }
#           }
#         ],
#         "visibility": "PRIVATE"
#       }
#     }
#   ]
# }

# 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 item_dataName [CkJsonObject_stringOf $jResp "objects[i].item_data.name"]
    set item_dataDescription [CkJsonObject_stringOf $jResp "objects[i].item_data.description"]
    set item_dataCategory_id [CkJsonObject_stringOf $jResp "objects[i].item_data.category_id"]
    set item_dataProduct_type [CkJsonObject_stringOf $jResp "objects[i].item_data.product_type"]
    set item_dataVisibility [CkJsonObject_stringOf $jResp "objects[i].item_data.visibility"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "objects[i].item_data.tax_ids"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "objects[i].item_data.tax_ids[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "objects[i].item_data.variations"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set v_type [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].type"]
        set id [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].id"]
        set updated_at [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].updated_at"]
        set version [CkJsonObject_IntOf $jResp "objects[i].item_data.variations[j].version"]
        set is_deleted [CkJsonObject_BoolOf $jResp "objects[i].item_data.variations[j].is_deleted"]
        set present_at_all_locations [CkJsonObject_BoolOf $jResp "objects[i].item_data.variations[j].present_at_all_locations"]
        set item_variation_dataItem_id [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.item_id"]
        set item_variation_dataName [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.name"]
        set item_variation_dataOrdinal [CkJsonObject_IntOf $jResp "objects[i].item_data.variations[j].item_variation_data.ordinal"]
        set item_variation_dataPrice_moneyAmount [CkJsonObject_IntOf $jResp "objects[i].item_data.variations[j].item_variation_data.price_money.amount"]
        set item_variation_dataPrice_moneyCurrency [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.price_money.currency"]
        set item_variation_dataPricing_type [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.pricing_type"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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