C++

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

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    bool success = false;

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

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

    // This example uses the sandbox: connect.squareupsandbox.com
    // Production should use connect.squareup.com
    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    // See this example explaining how this memory should be used: const char * functions.

    const char *v_type = 0;
    const char *id = 0;
    const char *updated_at = 0;
    int version;
    bool is_deleted;
    bool present_at_all_locations;
    const char *category_dataName = 0;
    const char *tax_dataName = 0;
    const char *tax_dataCalculation_phase = 0;
    const char *tax_dataInclusion_type = 0;
    const char *tax_dataPercentage = 0;
    bool tax_dataEnabled;

    int i = 0;
    int count_i = jResp.SizeOfArray("objects");
    while (i < count_i) {
        jResp.put_I(i);
        v_type = jResp.stringOf("objects[i].type");
        id = jResp.stringOf("objects[i].id");
        updated_at = jResp.stringOf("objects[i].updated_at");
        version = jResp.IntOf("objects[i].version");
        is_deleted = jResp.BoolOf("objects[i].is_deleted");
        present_at_all_locations = jResp.BoolOf("objects[i].present_at_all_locations");
        category_dataName = jResp.stringOf("objects[i].category_data.name");
        tax_dataName = jResp.stringOf("objects[i].tax_data.name");
        tax_dataCalculation_phase = jResp.stringOf("objects[i].tax_data.calculation_phase");
        tax_dataInclusion_type = jResp.stringOf("objects[i].tax_data.inclusion_type");
        tax_dataPercentage = jResp.stringOf("objects[i].tax_data.percentage");
        tax_dataEnabled = jResp.BoolOf("objects[i].tax_data.enabled");
        i = i + 1;
    }
    }