(Visual FoxPro) Square API - List Catalog

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_type
LOCAL lcId
LOCAL lcUpdated_at
LOCAL lnVersion
LOCAL lnIs_deleted
LOCAL lnPresent_at_all_locations
LOCAL lcCategory_dataName
LOCAL lcTax_dataName
LOCAL lcTax_dataCalculation_phase
LOCAL lcTax_dataInclusion_type
LOCAL lcTax_dataPercentage
LOCAL lnTax_dataEnabled
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/list?types=category%2Ctax \
*   -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")

* 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/list?types=item,category,tax,image",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)

* {
*   "objects": [
*     {
*       "type": "CATEGORY",
*       "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
*       "updated_at": "2017-02-21T14:50:26.495Z",
*       "version": 1487688626495,
*       "is_deleted": false,
*       "present_at_all_locations": true,
*       "category_data": {
*         "name": "Beverages"
*       }
*     },
*     {
*       "type": "TAX",
*       "id": "L5R47DGBZOOVKCAFIXC56AEN",
*       "updated_at": "2017-02-21T14:50:26.495Z",
*       "version": 1487688626495,
*       "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

i = 0
lnCount_i = loJResp.SizeOfArray("objects")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcV_type = loJResp.StringOf("objects[i].type")
    lcId = loJResp.StringOf("objects[i].id")
    lcUpdated_at = loJResp.StringOf("objects[i].updated_at")
    lnVersion = loJResp.IntOf("objects[i].version")
    lnIs_deleted = loJResp.BoolOf("objects[i].is_deleted")
    lnPresent_at_all_locations = loJResp.BoolOf("objects[i].present_at_all_locations")
    lcCategory_dataName = loJResp.StringOf("objects[i].category_data.name")
    lcTax_dataName = loJResp.StringOf("objects[i].tax_data.name")
    lcTax_dataCalculation_phase = loJResp.StringOf("objects[i].tax_data.calculation_phase")
    lcTax_dataInclusion_type = loJResp.StringOf("objects[i].tax_data.inclusion_type")
    lcTax_dataPercentage = loJResp.StringOf("objects[i].tax_data.percentage")
    lnTax_dataEnabled = loJResp.BoolOf("objects[i].tax_data.enabled")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp