(Ruby) Square API - Retrieve Catalog Object

Returns a single CatalogItem as a CatalogObject based on the provided ID.

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

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl https://connect.squareup.com/v2/catalog/object/W62UWFY35CWMYGVWK6TWJDNI?include_related_objects=true 
#   -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.
http.put_AuthToken("ACCESS_TOKEN")
http.SetRequestHeader("Square-Version","2020-07-22")
http.SetRequestHeader("Content-Type","application/json")

http.SetUrlVar("id","2PTZYUOFGGDMT75UZLHQAPAC")

# This example uses the sandbox: connect.squareupsandbox.com
# Production should use connect.squareup.com
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "object": {
#     "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"
#             }
#           }
#         }
#       ]
#     }
#   },
#   "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

objectType = jResp.stringOf("object.type")
objectId = jResp.stringOf("object.id")
objectUpdated_at = jResp.stringOf("object.updated_at")
objectVersion = jResp.IntOf("object.version")
objectIs_deleted = jResp.BoolOf("object.is_deleted")
objectPresent_at_all_locations = jResp.BoolOf("object.present_at_all_locations")
objectItem_dataName = jResp.stringOf("object.item_data.name")
objectItem_dataDescription = jResp.stringOf("object.item_data.description")
objectItem_dataCategory_id = jResp.stringOf("object.item_data.category_id")
i = 0
count_i = jResp.SizeOfArray("object.item_data.tax_ids")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("object.item_data.tax_ids[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("object.item_data.variations")
while i < count_i
    jResp.put_I(i)
    v_type = jResp.stringOf("object.item_data.variations[i].type")
    id = jResp.stringOf("object.item_data.variations[i].id")
    updated_at = jResp.stringOf("object.item_data.variations[i].updated_at")
    version = jResp.IntOf("object.item_data.variations[i].version")
    is_deleted = jResp.BoolOf("object.item_data.variations[i].is_deleted")
    present_at_all_locations = jResp.BoolOf("object.item_data.variations[i].present_at_all_locations")
    item_variation_dataItem_id = jResp.stringOf("object.item_data.variations[i].item_variation_data.item_id")
    item_variation_dataName = jResp.stringOf("object.item_data.variations[i].item_variation_data.name")
    item_variation_dataOrdinal = jResp.IntOf("object.item_data.variations[i].item_variation_data.ordinal")
    item_variation_dataPricing_type = jResp.stringOf("object.item_data.variations[i].item_variation_data.pricing_type")
    item_variation_dataPrice_moneyAmount = jResp.IntOf("object.item_data.variations[i].item_variation_data.price_money.amount")
    item_variation_dataPrice_moneyCurrency = jResp.stringOf("object.item_data.variations[i].item_variation_data.price_money.currency")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("related_objects")
while i < count_i
    jResp.put_I(i)
    v_type = jResp.stringOf("related_objects[i].type")
    id = jResp.stringOf("related_objects[i].id")
    updated_at = jResp.stringOf("related_objects[i].updated_at")
    version = jResp.IntOf("related_objects[i].version")
    is_deleted = jResp.BoolOf("related_objects[i].is_deleted")
    present_at_all_locations = jResp.BoolOf("related_objects[i].present_at_all_locations")
    category_dataName = jResp.stringOf("related_objects[i].category_data.name")
    tax_dataName = jResp.stringOf("related_objects[i].tax_data.name")
    tax_dataCalculation_phase = jResp.stringOf("related_objects[i].tax_data.calculation_phase")
    tax_dataInclusion_type = jResp.stringOf("related_objects[i].tax_data.inclusion_type")
    tax_dataPercentage = jResp.stringOf("related_objects[i].tax_data.percentage")
    tax_dataEnabled = jResp.BoolOf("related_objects[i].tax_data.enabled")
    i = i + 1
end