(Node.js) 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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var http = new chilkat.Http();
    var 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
    // }

    var json = new chilkat.JsonObject();
    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.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
    // resp: HttpResponse
    var resp = http.PostJson3("https://connect.squareupsandbox.com/v2/catalog/search","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);
    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

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

    var v_type;
    var id;
    var updated_at;
    var version;
    var is_deleted;
    var present_at_all_locations;
    var item_dataName;
    var item_dataDescription;
    var item_dataCategory_id;
    var item_dataProduct_type;
    var item_dataVisibility;
    var j;
    var count_j;
    var strVal;
    var item_variation_dataItem_id;
    var item_variation_dataName;
    var item_variation_dataOrdinal;
    var item_variation_dataPrice_moneyAmount;
    var item_variation_dataPrice_moneyCurrency;
    var item_variation_dataPricing_type;

    var i = 0;
    var count_i = jResp.SizeOfArray("objects");
    while (i < count_i) {
        jResp.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.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.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;
    }


}

chilkatExample();