(MFC) 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++ Libs

See Also: Using MFC CString in Chilkat

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

void ChilkatSample(void)
    {
    CkString strOut;

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

    CkHttp http;
    bool success;

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

    CkJsonObject json;
    json.UpdateString("object_types[0]","ITEM");
    json.UpdateString("query.prefix_query.attribute_name","name");
    json.UpdateString("query.prefix_query.attribute_prefix","tea");
    json.UpdateInt("limit",100);

    // 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
    CkHttpResponse *resp = http.PostJson3("https://connect.squareupsandbox.com/v2/catalog/search","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        strOut.append(http.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);
    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    strOut.append("Response Body:");
    strOut.append("\r\n");
    strOut.append(jResp.emit());
    strOut.append("\r\n");

    int respStatusCode = resp->get_StatusCode();
    strOut.append("Response Status Code = ");
    strOut.appendInt(respStatusCode);
    strOut.append("\r\n");
    if (respStatusCode >= 400) {
        strOut.append("Response Header:");
        strOut.append("\r\n");
        strOut.append(resp->header());
        strOut.append("\r\n");
        strOut.append("Failed.");
        strOut.append("\r\n");
        delete resp;
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

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

    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 *item_dataName = 0;
    const char *item_dataDescription = 0;
    const char *item_dataCategory_id = 0;
    const char *item_dataProduct_type = 0;
    const char *item_dataVisibility = 0;
    int j;
    int count_j;
    const char *strVal = 0;
    const char *item_variation_dataItem_id = 0;
    const char *item_variation_dataName = 0;
    int item_variation_dataOrdinal;
    int item_variation_dataPrice_moneyAmount;
    const char *item_variation_dataPrice_moneyCurrency = 0;
    const char *item_variation_dataPricing_type = 0;

    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");
        item_dataName = jResp.stringOf("objects[i].item_data.name");
        item_dataDescription = jResp.stringOf("objects[i].item_data.description");
        item_dataCategory_id = jResp.stringOf("objects[i].item_data.category_id");
        item_dataProduct_type = jResp.stringOf("objects[i].item_data.product_type");
        item_dataVisibility = jResp.stringOf("objects[i].item_data.visibility");
        j = 0;
        count_j = jResp.SizeOfArray("objects[i].item_data.tax_ids");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf("objects[i].item_data.tax_ids[j]");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("objects[i].item_data.variations");
        while (j < count_j) {
            jResp.put_J(j);
            v_type = jResp.stringOf("objects[i].item_data.variations[j].type");
            id = jResp.stringOf("objects[i].item_data.variations[j].id");
            updated_at = jResp.stringOf("objects[i].item_data.variations[j].updated_at");
            version = jResp.IntOf("objects[i].item_data.variations[j].version");
            is_deleted = jResp.BoolOf("objects[i].item_data.variations[j].is_deleted");
            present_at_all_locations = jResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations");
            item_variation_dataItem_id = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.item_id");
            item_variation_dataName = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.name");
            item_variation_dataOrdinal = jResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal");
            item_variation_dataPrice_moneyAmount = jResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount");
            item_variation_dataPrice_moneyCurrency = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency");
            item_variation_dataPricing_type = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type");
            j = j + 1;
        }

        i = i + 1;
    }



    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }