Xbase++

Square API - List Catalog

See more Square Examples

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. Xbase++

LOCAL nSuccess
LOCAL oHttp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cV_type
LOCAL cId
LOCAL cUpdated_at
LOCAL nVersion
LOCAL nIs_deleted
LOCAL nPresent_at_all_locations
LOCAL cCategory_dataName
LOCAL cTax_dataName
LOCAL cTax_dataCalculation_phase
LOCAL cTax_dataInclusion_type
LOCAL cTax_dataPercentage
LOCAL nTax_dataEnabled
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

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

//  This example uses the sandbox: connect.squareupsandbox.com
//  Production should use connect.squareup.com
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oHttp:QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image", oSbResponseBody)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

nRespStatusCode := oHttp:LastStatus
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oHttp:LastHeader
    ? "Failed."
    oHttp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    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
nCount_i := oJResp:SizeOfArray("objects")
DO WHILE i < nCount_i
    oJResp:I := i
    cV_type := oJResp:StringOf("objects[i].type")
    cId := oJResp:StringOf("objects[i].id")
    cUpdated_at := oJResp:StringOf("objects[i].updated_at")
    nVersion := oJResp:IntOf("objects[i].version")
    nIs_deleted := oJResp:BoolOf("objects[i].is_deleted")
    nPresent_at_all_locations := oJResp:BoolOf("objects[i].present_at_all_locations")
    cCategory_dataName := oJResp:StringOf("objects[i].category_data.name")
    cTax_dataName := oJResp:StringOf("objects[i].tax_data.name")
    cTax_dataCalculation_phase := oJResp:StringOf("objects[i].tax_data.calculation_phase")
    cTax_dataInclusion_type := oJResp:StringOf("objects[i].tax_data.inclusion_type")
    cTax_dataPercentage := oJResp:StringOf("objects[i].tax_data.percentage")
    nTax_dataEnabled := oJResp:BoolOf("objects[i].tax_data.enabled")
    i := i + 1
ENDDO

oHttp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()