Sample code for 30+ languages & platforms
JavaScript

Upsert Catalog Object

See more Square Examples

Creates or updates the target CatalogObject.
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.
JavaScript
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 \
//   -X POST \
//   -H 'Square-Version: 2020-07-22' \
//   -H 'Authorization: Bearer ACCESS_TOKEN' \
//   -H 'Content-Type: application/json' \
//   -d '{
//     "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
//     "object": {
//       "type": "ITEM",
//       "id": "#Cocoa",
//       "item_data": {
//         "name": "Cocoa",
//         "description": "Hot chocolate",
//         "abbreviation": "Ch"
//       }
//     }
//   }'

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

// {
//   "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
//   "object": {
//     "type": "ITEM",
//     "id": "#Cocoa",
//     "item_data": {
//       "name": "Cocoa",
//       "description": "Hot chocolate",
//       "abbreviation": "Ch"
//     }
//   }
// }

var json = new CkJsonObject();
json.UpdateString("idempotency_key","af3d1afc-7212-4300-b463-0bfc5314a5ae");
json.UpdateString("object.type","ITEM");
json.UpdateString("object.id","#Cocoa");
json.UpdateString("object.item_data.name","Cocoa");
json.UpdateString("object.item_data.description","Hot chocolate");
json.UpdateString("object.item_data.abbreviation","Ch");

// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.AuthToken = "ACCESS_TOKEN";
http.SetRequestHeader("Square-Version","2020-07-22");

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/object",json,"application/json",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)

// {
//   "catalog_object": {
//     "type": "ITEM",
//     "id": "7SB3ZQYJ5GDMVFL7JK46JCHT",
//     "updated_at": "2016-11-16T22:32:42.996Z",
//     "version": 1479335562996,
//     "is_deleted": false,
//     "item_data": {
//       "name": "Cocoa",
//       "description": "Hot chocolate",
//       "abbreviation": "Ch"
//     }
//   },
//   "id_mappings": [
//     {
//       "client_object_id": "#Cocoa",
//       "object_id": "7SB3ZQYJ5GDMVFL7JK46JCHT"
//     }
//   ]
// }

// 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 client_object_id;
var object_id;

var catalog_objectType = jResp.StringOf("catalog_object.type");
var catalog_objectId = jResp.StringOf("catalog_object.id");
var catalog_objectUpdated_at = jResp.StringOf("catalog_object.updated_at");
var catalog_objectVersion = jResp.IntOf("catalog_object.version");
var catalog_objectIs_deleted = jResp.BoolOf("catalog_object.is_deleted");
var catalog_objectItem_dataName = jResp.StringOf("catalog_object.item_data.name");
var catalog_objectItem_dataDescription = jResp.StringOf("catalog_object.item_data.description");
var catalog_objectItem_dataAbbreviation = jResp.StringOf("catalog_object.item_data.abbreviation");
var i = 0;
var count_i = jResp.SizeOfArray("id_mappings");
while (i < count_i) {
    jResp.I = i;
    client_object_id = jResp.StringOf("id_mappings[i].client_object_id");
    object_id = jResp.StringOf("id_mappings[i].object_id");
    i = i+1;
}