(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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.
    CkHttp::setCkAuthToken(http, "ACCESS_TOKEN")
    CkHttp::ckSetRequestHeader(http,"Square-Version","2020-07-22")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    ; This example uses the sandbox: connect.squareupsandbox.com
    ; Production should use connect.squareup.com
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

    v_type.s
    id.s
    updated_at.s
    version.i
    is_deleted.i
    present_at_all_locations.i
    category_dataName.s
    tax_dataName.s
    tax_dataCalculation_phase.s
    tax_dataInclusion_type.s
    tax_dataPercentage.s
    tax_dataEnabled.i

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"objects")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        v_type = CkJsonObject::ckStringOf(jResp,"objects[i].type")
        id = CkJsonObject::ckStringOf(jResp,"objects[i].id")
        updated_at = CkJsonObject::ckStringOf(jResp,"objects[i].updated_at")
        version = CkJsonObject::ckIntOf(jResp,"objects[i].version")
        is_deleted = CkJsonObject::ckBoolOf(jResp,"objects[i].is_deleted")
        present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"objects[i].present_at_all_locations")
        category_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].category_data.name")
        tax_dataName = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.name")
        tax_dataCalculation_phase = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.calculation_phase")
        tax_dataInclusion_type = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.inclusion_type")
        tax_dataPercentage = CkJsonObject::ckStringOf(jResp,"objects[i].tax_data.percentage")
        tax_dataEnabled = CkJsonObject::ckBoolOf(jResp,"objects[i].tax_data.enabled")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure