(JavaScript) Square API - Delete Catalog Object

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response.

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl https://connect.squareup.com/v2/catalog/object/object_id0 \
//   -X DELETE \
//   -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.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

http.SetUrlVar("object_id","2PTZYUOFGGDMT75UZLHQAPAC");
var resp = new CkHttpResponse();
success = http.HttpNoBody("DELETE","https://connect.squareupsandbox.com/v2/catalog/object/{$object_id}",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
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)

// {
//   "deleted_object_ids": [
//     "2PTZYUOFGGDMT75UZLHQAPAC",
//     "KQLFFHA6K6J3YQAQAWDQAL57"
//   ],
//   "deleted_at": "2016-11-16T22:25:24.878Z"
// }

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

var deleted_at = jResp.StringOf("deleted_at");
var i = 0;
var count_i = jResp.SizeOfArray("deleted_object_ids");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("deleted_object_ids[i]");
    i = i+1;
}