(Unicode C) Square API - Search Catalog Objects

Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,

For more information, see https://developer.squareup.com/reference/square/catalog-api/search-catalog-objects

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *v_type;
    const wchar_t *id;
    const wchar_t *updated_at;
    int version;
    BOOL is_deleted;
    BOOL present_at_all_locations;
    const wchar_t *item_dataName;
    const wchar_t *item_dataDescription;
    const wchar_t *item_dataCategory_id;
    const wchar_t *item_dataProduct_type;
    const wchar_t *item_dataVisibility;
    int j;
    int count_j;
    const wchar_t *strVal;
    const wchar_t *item_variation_dataItem_id;
    const wchar_t *item_variation_dataName;
    int item_variation_dataOrdinal;
    int item_variation_dataPrice_moneyAmount;
    const wchar_t *item_variation_dataPrice_moneyCurrency;
    const wchar_t *item_variation_dataPricing_type;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    // Implements the following CURL command:

    // curl https://connect.squareup.com/v2/catalog/search \
    //   -X POST \
    //   -H 'Square-Version: 2020-07-22' \
    //   -H 'Authorization: Bearer ACCESS_TOKEN' \
    //   -H 'Content-Type: application/json' \
    //   -d '{
    //     "object_types": [
    //       "ITEM"
    //     ],
    //     "query": {
    //       "prefix_query": {
    //         "attribute_name": "name",
    //         "attribute_prefix": "tea"
    //       }
    //     },
    //     "limit": 100
    //   }'

    // Use the following online tool to generate HTTP code from a CURL command
    // Convert a cURL Command to HTTP Source Code

    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "object_types": [
    //     "ITEM"
    //   ],
    //   "query": {
    //     "prefix_query": {
    //       "attribute_name": "name",
    //       "attribute_prefix": "tea"
    //     }
    //   },
    //   "limit": 100
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"object_types[0]",L"ITEM");
    CkJsonObjectW_UpdateString(json,L"query.prefix_query.attribute_name",L"name");
    CkJsonObjectW_UpdateString(json,L"query.prefix_query.attribute_prefix",L"tea");
    CkJsonObjectW_UpdateInt(json,L"limit",100);

    // Adds the "Authorization: Bearer ACCESS_TOKEN" header.
    CkHttpW_putAuthToken(http,L"ACCESS_TOKEN");
    CkHttpW_SetRequestHeader(http,L"Square-Version",L"2020-07-22");
    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");

    // This example uses the sandbox: connect.squareupsandbox.com
    // Production should use connect.squareup.com
    resp = CkHttpW_PostJson3(http,L"https://connect.squareupsandbox.com/v2/catalog/search",L"application/json",json);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);
    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "objects": [
    //     {
    //       "type": "ITEM",
    //       "id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
    //       "updated_at": "2017-10-26T15:41:32.337Z",
    //       "version": 1509032492337,
    //       "is_deleted": false,
    //       "present_at_all_locations": true,
    //       "item_data": {
    //         "name": "Tea - Black",
    //         "description": "A delicious blend of black tea.",
    //         "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
    //         "product_type": "REGULAR",
    //         "tax_ids": [
    //           "ZXITPM6RWHZ7GZ7EIP3YKECM"
    //         ],
    //         "variations": [
    //           {
    //             "type": "ITEM_VARIATION",
    //             "id": "5GSZPX6EU7MM75S57OONG3V5",
    //             "updated_at": "2017-10-26T15:27:31.626Z",
    //             "version": 1509031651626,
    //             "is_deleted": false,
    //             "present_at_all_locations": true,
    //             "item_variation_data": {
    //               "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
    //               "name": "Regular",
    //               "ordinal": 1,
    //               "price_money": {
    //                 "amount": 150,
    //                 "currency": "USD"
    //               },
    //               "pricing_type": "FIXED_PRICING"
    //             }
    //           },
    //           {
    //             "type": "ITEM_VARIATION",
    //             "id": "XVLBN7DU6JTWHJTG5F265B43",
    //             "updated_at": "2017-10-26T15:27:31.626Z",
    //             "version": 1509031651626,
    //             "is_deleted": false,
    //             "present_at_all_locations": true,
    //             "item_variation_data": {
    //               "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
    //               "name": "Large",
    //               "ordinal": 2,
    //               "price_money": {
    //                 "amount": 225,
    //                 "currency": "USD"
    //               },
    //               "pricing_type": "FIXED_PRICING"
    //             }
    //           }
    //         ],
    //         "visibility": "PRIVATE"
    //       }
    //     },
    //     {
    //       "type": "ITEM",
    //       "id": "NNNEM3LA656Q46NXLWCNI7S5",
    //       "updated_at": "2017-10-26T15:41:23.232Z",
    //       "version": 1509032483232,
    //       "is_deleted": false,
    //       "present_at_all_locations": true,
    //       "item_data": {
    //         "name": "Tea - Green",
    //         "description": "Relaxing green herbal tea.",
    //         "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
    //         "product_type": "REGULAR",
    //         "tax_ids": [
    //           "ZXITPM6RWHZ7GZ7EIP3YKECM"
    //         ],
    //         "variations": [
    //           {
    //             "type": "ITEM_VARIATION",
    //             "id": "FHYBVIA6NVBCSOVETA62WEA4",
    //             "updated_at": "2017-10-26T15:29:00.524Z",
    //             "version": 1509031740524,
    //             "is_deleted": false,
    //             "present_at_all_locations": true,
    //             "item_variation_data": {
    //               "item_id": "NNNEM3LA656Q46NXLWCNI7S5",
    //               "name": "Regular",
    //               "ordinal": 1,
    //               "price_money": {
    //                 "amount": 150,
    //                 "currency": "USD"
    //               },
    //               "pricing_type": "FIXED_PRICING"
    //             }
    //           }
    //         ],
    //         "visibility": "PRIVATE"
    //       }
    //     }
    //   ]
    // }

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

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"objects");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        v_type = CkJsonObjectW_stringOf(jResp,L"objects[i].type");
        id = CkJsonObjectW_stringOf(jResp,L"objects[i].id");
        updated_at = CkJsonObjectW_stringOf(jResp,L"objects[i].updated_at");
        version = CkJsonObjectW_IntOf(jResp,L"objects[i].version");
        is_deleted = CkJsonObjectW_BoolOf(jResp,L"objects[i].is_deleted");
        present_at_all_locations = CkJsonObjectW_BoolOf(jResp,L"objects[i].present_at_all_locations");
        item_dataName = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.name");
        item_dataDescription = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.description");
        item_dataCategory_id = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.category_id");
        item_dataProduct_type = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.product_type");
        item_dataVisibility = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.visibility");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"objects[i].item_data.tax_ids");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            strVal = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.tax_ids[j]");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"objects[i].item_data.variations");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            v_type = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].type");
            id = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].id");
            updated_at = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].updated_at");
            version = CkJsonObjectW_IntOf(jResp,L"objects[i].item_data.variations[j].version");
            is_deleted = CkJsonObjectW_BoolOf(jResp,L"objects[i].item_data.variations[j].is_deleted");
            present_at_all_locations = CkJsonObjectW_BoolOf(jResp,L"objects[i].item_data.variations[j].present_at_all_locations");
            item_variation_dataItem_id = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].item_variation_data.item_id");
            item_variation_dataName = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].item_variation_data.name");
            item_variation_dataOrdinal = CkJsonObjectW_IntOf(jResp,L"objects[i].item_data.variations[j].item_variation_data.ordinal");
            item_variation_dataPrice_moneyAmount = CkJsonObjectW_IntOf(jResp,L"objects[i].item_data.variations[j].item_variation_data.price_money.amount");
            item_variation_dataPrice_moneyCurrency = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].item_variation_data.price_money.currency");
            item_variation_dataPricing_type = CkJsonObjectW_stringOf(jResp,L"objects[i].item_data.variations[j].item_variation_data.pricing_type");
            j = j + 1;
        }

        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }