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

    CkHttp::ckSetUrlVar(http,"id","2PTZYUOFGGDMT75UZLHQAPAC")

    ; 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/object/{$id}?include_related_objects=true",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)

    ; {
    ;   "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

    strVal.s
    v_type.s
    id.s
    updated_at.s
    version.i
    is_deleted.i
    present_at_all_locations.i
    item_variation_dataItem_id.s
    item_variation_dataName.s
    item_variation_dataOrdinal.i
    item_variation_dataPricing_type.s
    item_variation_dataPrice_moneyAmount.i
    item_variation_dataPrice_moneyCurrency.s
    category_dataName.s
    tax_dataName.s
    tax_dataCalculation_phase.s
    tax_dataInclusion_type.s
    tax_dataPercentage.s
    tax_dataEnabled.i

    objectType.s = CkJsonObject::ckStringOf(jResp,"object.type")
    objectId.s = CkJsonObject::ckStringOf(jResp,"object.id")
    objectUpdated_at.s = CkJsonObject::ckStringOf(jResp,"object.updated_at")
    objectVersion.i = CkJsonObject::ckIntOf(jResp,"object.version")
    objectIs_deleted.i = CkJsonObject::ckBoolOf(jResp,"object.is_deleted")
    objectPresent_at_all_locations.i = CkJsonObject::ckBoolOf(jResp,"object.present_at_all_locations")
    objectItem_dataName.s = CkJsonObject::ckStringOf(jResp,"object.item_data.name")
    objectItem_dataDescription.s = CkJsonObject::ckStringOf(jResp,"object.item_data.description")
    objectItem_dataCategory_id.s = CkJsonObject::ckStringOf(jResp,"object.item_data.category_id")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"object.item_data.tax_ids")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"object.item_data.tax_ids[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"object.item_data.variations")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        v_type = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].type")
        id = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].id")
        updated_at = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].updated_at")
        version = CkJsonObject::ckIntOf(jResp,"object.item_data.variations[i].version")
        is_deleted = CkJsonObject::ckBoolOf(jResp,"object.item_data.variations[i].is_deleted")
        present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"object.item_data.variations[i].present_at_all_locations")
        item_variation_dataItem_id = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].item_variation_data.item_id")
        item_variation_dataName = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].item_variation_data.name")
        item_variation_dataOrdinal = CkJsonObject::ckIntOf(jResp,"object.item_data.variations[i].item_variation_data.ordinal")
        item_variation_dataPricing_type = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].item_variation_data.pricing_type")
        item_variation_dataPrice_moneyAmount = CkJsonObject::ckIntOf(jResp,"object.item_data.variations[i].item_variation_data.price_money.amount")
        item_variation_dataPrice_moneyCurrency = CkJsonObject::ckStringOf(jResp,"object.item_data.variations[i].item_variation_data.price_money.currency")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"related_objects")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        v_type = CkJsonObject::ckStringOf(jResp,"related_objects[i].type")
        id = CkJsonObject::ckStringOf(jResp,"related_objects[i].id")
        updated_at = CkJsonObject::ckStringOf(jResp,"related_objects[i].updated_at")
        version = CkJsonObject::ckIntOf(jResp,"related_objects[i].version")
        is_deleted = CkJsonObject::ckBoolOf(jResp,"related_objects[i].is_deleted")
        present_at_all_locations = CkJsonObject::ckBoolOf(jResp,"related_objects[i].present_at_all_locations")
        category_dataName = CkJsonObject::ckStringOf(jResp,"related_objects[i].category_data.name")
        tax_dataName = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.name")
        tax_dataCalculation_phase = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.calculation_phase")
        tax_dataInclusion_type = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.inclusion_type")
        tax_dataPercentage = CkJsonObject::ckStringOf(jResp,"related_objects[i].tax_data.percentage")
        tax_dataEnabled = CkJsonObject::ckBoolOf(jResp,"related_objects[i].tax_data.enabled")
        i = i + 1
    Wend


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


    ProcedureReturn
EndProcedure