(Tcl) Square API - Batch Retrieve Catalog Objects

Returns a set of objects based on the provided ID.

For more information, see https://developer.squareup.com/reference/square/catalog-api/batch-retrieve-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/batch-retrieve \
#   -X POST \
#   -H 'Square-Version: 2020-07-22' \
#   -H 'Authorization: Bearer ACCESS_TOKEN' \
#   -H 'Content-Type: application/json' \
#   -d '{
#     "object_ids": [
#       "W62UWFY35CWMYGVWK6TWJDNI",
#       "AA27W3M2GGTF3H6AVPNB77CK"
#     ],
#     "include_related_objects": true
#   }'

# 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_ids": [
#     "W62UWFY35CWMYGVWK6TWJDNI",
#     "AA27W3M2GGTF3H6AVPNB77CK"
#   ],
#   "include_related_objects": true
# }

set json [new_CkJsonObject]

set i 0
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "object_ids[i]" "W62UWFY35CWMYGVWK6TWJDNI"
set i [expr $i + 1]
CkJsonObject_put_I $json $i
CkJsonObject_UpdateString $json "object_ids[i]" "AA27W3M2GGTF3H6AVPNB77CK"
CkJsonObject_UpdateBool $json "include_related_objects" 1

# 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/batch-retrieve" "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": "W62UWFY35CWMYGVWK6TWJDNI",
#       "updated_at": "2016-11-16T22:25:24.878Z",
#       "version": 1479335124878,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "item_data": {
#         "name": "Tea",
#         "description": "Hot Leaf Juice",
#         "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
#         "tax_ids": [
#           "HURXQOOAIC4IZSI2BEXQRYFY"
#         ],
#         "variations": [
#           {
#             "type": "ITEM_VARIATION",
#             "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
#             "updated_at": "2016-11-16T22:25:24.878Z",
#             "version": 1479335124878,
#             "is_deleted": false,
#             "present_at_all_locations": true,
#             "item_variation_data": {
#               "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
#               "name": "Mug",
#               "ordinal": 0,
#               "pricing_type": "FIXED_PRICING",
#               "price_money": {
#                 "amount": 150,
#                 "currency": "USD"
#               }
#             }
#           }
#         ]
#       }
#     },
#     {
#       "type": "ITEM",
#       "id": "AA27W3M2GGTF3H6AVPNB77CK",
#       "updated_at": "2016-11-16T22:25:24.878Z",
#       "version": 1479335124878,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "item_data": {
#         "name": "Coffee",
#         "description": "Hot Bean Juice",
#         "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
#         "tax_ids": [
#           "HURXQOOAIC4IZSI2BEXQRYFY"
#         ],
#         "variations": [
#           {
#             "type": "ITEM_VARIATION",
#             "id": "LBTYIHNHU52WOIHWT7SNRIYH",
#             "updated_at": "2016-11-16T22:25:24.878Z",
#             "version": 1479335124878,
#             "is_deleted": false,
#             "present_at_all_locations": true,
#             "item_variation_data": {
#               "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
#               "name": "Regular",
#               "ordinal": 0,
#               "pricing_type": "FIXED_PRICING",
#               "price_money": {
#                 "amount": 250,
#                 "currency": "USD"
#               }
#             }
#           },
#           {
#             "type": "ITEM_VARIATION",
#             "id": "PKYIC7HGGKW5CYVSCVDEIMHY",
#             "updated_at": "2016-11-16T22:25:24.878Z",
#             "version": 1479335124878,
#             "is_deleted": false,
#             "present_at_all_locations": true,
#             "item_variation_data": {
#               "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
#               "name": "Large",
#               "ordinal": 1,
#               "pricing_type": "FIXED_PRICING",
#               "price_money": {
#                 "amount": 350,
#                 "currency": "USD"
#               }
#             }
#           }
#         ]
#       }
#     }
#   ],
#   "related_objects": [
#     {
#       "type": "CATEGORY",
#       "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
#       "updated_at": "2016-11-16T22:25:24.878Z",
#       "version": 1479335124878,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "category_data": {
#         "name": "Beverages"
#       }
#     },
#     {
#       "type": "TAX",
#       "id": "HURXQOOAIC4IZSI2BEXQRYFY",
#       "updated_at": "2016-11-16T22:25:24.878Z",
#       "version": 1479335124878,
#       "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 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 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_dataPricing_type [CkJsonObject_stringOf $jResp "objects[i].item_data.variations[j].item_variation_data.pricing_type"]
        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 j [expr $j + 1]
    }
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "related_objects"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_type [CkJsonObject_stringOf $jResp "related_objects[i].type"]
    set id [CkJsonObject_stringOf $jResp "related_objects[i].id"]
    set updated_at [CkJsonObject_stringOf $jResp "related_objects[i].updated_at"]
    set version [CkJsonObject_IntOf $jResp "related_objects[i].version"]
    set is_deleted [CkJsonObject_BoolOf $jResp "related_objects[i].is_deleted"]
    set present_at_all_locations [CkJsonObject_BoolOf $jResp "related_objects[i].present_at_all_locations"]
    set category_dataName [CkJsonObject_stringOf $jResp "related_objects[i].category_data.name"]
    set tax_dataName [CkJsonObject_stringOf $jResp "related_objects[i].tax_data.name"]
    set tax_dataCalculation_phase [CkJsonObject_stringOf $jResp "related_objects[i].tax_data.calculation_phase"]
    set tax_dataInclusion_type [CkJsonObject_stringOf $jResp "related_objects[i].tax_data.inclusion_type"]
    set tax_dataPercentage [CkJsonObject_stringOf $jResp "related_objects[i].tax_data.percentage"]
    set tax_dataEnabled [CkJsonObject_BoolOf $jResp "related_objects[i].tax_data.enabled"]
    set i [expr $i + 1]
}

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