(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// 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.
loHttp.AuthToken = "ACCESS_TOKEN"
loHttp.SetRequestHeader("Square-Version","2020-07-22")
loHttp.SetRequestHeader("Content-Type","application/json")

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

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// 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

lcObjectType = loJResp.StringOf("object.type")
lcObjectId = loJResp.StringOf("object.id")
lcObjectUpdated_at = loJResp.StringOf("object.updated_at")
lnObjectVersion = loJResp.IntOf("object.version")
llObjectIs_deleted = loJResp.BoolOf("object.is_deleted")
llObjectPresent_at_all_locations = loJResp.BoolOf("object.present_at_all_locations")
lcObjectItem_dataName = loJResp.StringOf("object.item_data.name")
lcObjectItem_dataDescription = loJResp.StringOf("object.item_data.description")
lcObjectItem_dataCategory_id = loJResp.StringOf("object.item_data.category_id")
i = 0
lnCount_i = loJResp.SizeOfArray("object.item_data.tax_ids")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("object.item_data.tax_ids[i]")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("object.item_data.variations")
do while i < lnCount_i
    loJResp.I = i
    lcV_type = loJResp.StringOf("object.item_data.variations[i].type")
    lcId = loJResp.StringOf("object.item_data.variations[i].id")
    lcUpdated_at = loJResp.StringOf("object.item_data.variations[i].updated_at")
    lnVersion = loJResp.IntOf("object.item_data.variations[i].version")
    llIs_deleted = loJResp.BoolOf("object.item_data.variations[i].is_deleted")
    llPresent_at_all_locations = loJResp.BoolOf("object.item_data.variations[i].present_at_all_locations")
    lcItem_variation_dataItem_id = loJResp.StringOf("object.item_data.variations[i].item_variation_data.item_id")
    lcItem_variation_dataName = loJResp.StringOf("object.item_data.variations[i].item_variation_data.name")
    lnItem_variation_dataOrdinal = loJResp.IntOf("object.item_data.variations[i].item_variation_data.ordinal")
    lcItem_variation_dataPricing_type = loJResp.StringOf("object.item_data.variations[i].item_variation_data.pricing_type")
    lnItem_variation_dataPrice_moneyAmount = loJResp.IntOf("object.item_data.variations[i].item_variation_data.price_money.amount")
    lcItem_variation_dataPrice_moneyCurrency = loJResp.StringOf("object.item_data.variations[i].item_variation_data.price_money.currency")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("related_objects")
do while i < lnCount_i
    loJResp.I = i
    lcV_type = loJResp.StringOf("related_objects[i].type")
    lcId = loJResp.StringOf("related_objects[i].id")
    lcUpdated_at = loJResp.StringOf("related_objects[i].updated_at")
    lnVersion = loJResp.IntOf("related_objects[i].version")
    llIs_deleted = loJResp.BoolOf("related_objects[i].is_deleted")
    llPresent_at_all_locations = loJResp.BoolOf("related_objects[i].present_at_all_locations")
    lcCategory_dataName = loJResp.StringOf("related_objects[i].category_data.name")
    lcTax_dataName = loJResp.StringOf("related_objects[i].tax_data.name")
    lcTax_dataCalculation_phase = loJResp.StringOf("related_objects[i].tax_data.calculation_phase")
    lcTax_dataInclusion_type = loJResp.StringOf("related_objects[i].tax_data.inclusion_type")
    lcTax_dataPercentage = loJResp.StringOf("related_objects[i].tax_data.percentage")
    llTax_dataEnabled = loJResp.BoolOf("related_objects[i].tax_data.enabled")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp