(Lianja) 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 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/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
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image",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)

// {
//   "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")
    llIs_deleted = loJResp.BoolOf("objects[i].is_deleted")
    llPresent_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")
    llTax_dataEnabled = loJResp.BoolOf("objects[i].tax_data.enabled")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp