(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcV_type
LOCAL lcId
LOCAL lcUpdated_at
LOCAL lnVersion
LOCAL lnIs_deleted
LOCAL lnPresent_at_all_locations
LOCAL lcItem_variation_dataItem_id
LOCAL lcItem_variation_dataName
LOCAL lnItem_variation_dataOrdinal
LOCAL lcItem_variation_dataPricing_type
LOCAL lnItem_variation_dataPrice_moneyAmount
LOCAL lcItem_variation_dataPrice_moneyCurrency
LOCAL lcCategory_dataName
LOCAL lcTax_dataName
LOCAL lcTax_dataCalculation_phase
LOCAL lcTax_dataInclusion_type
LOCAL lcTax_dataPercentage
LOCAL lnTax_dataEnabled
LOCAL lcObjectType
LOCAL lcObjectId
LOCAL lcObjectUpdated_at
LOCAL lnObjectVersion
LOCAL lnObjectIs_deleted
LOCAL lnObjectPresent_at_all_locations
LOCAL lcObjectItem_dataName
LOCAL lcObjectItem_dataDescription
LOCAL lcObjectItem_dataCategory_id
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
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")
lnObjectIs_deleted = loJResp.BoolOf("object.is_deleted")
lnObjectPresent_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")
    lnIs_deleted = loJResp.BoolOf("object.item_data.variations[i].is_deleted")
    lnPresent_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")
    lnIs_deleted = loJResp.BoolOf("related_objects[i].is_deleted")
    lnPresent_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")
    lnTax_dataEnabled = loJResp.BoolOf("related_objects[i].tax_data.enabled")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp