Ruby

Upsert Catalog Object

See more Square Examples

Creates or updates the target CatalogObject. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# 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"
#     }
#   }
# }

json = Chilkat::CkJsonObject.new()
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.put_AuthToken("ACCESS_TOKEN")
http.SetRequestHeader("Square-Version","2020-07-22")

# This example uses the sandbox: connect.squareupsandbox.com
# Production should use connect.squareup.com
resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/object",json,"application/json",resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

catalog_objectType = jResp.stringOf("catalog_object.type")
catalog_objectId = jResp.stringOf("catalog_object.id")
catalog_objectUpdated_at = jResp.stringOf("catalog_object.updated_at")
catalog_objectVersion = jResp.IntOf("catalog_object.version")
catalog_objectIs_deleted = jResp.BoolOf("catalog_object.is_deleted")
catalog_objectItem_dataName = jResp.stringOf("catalog_object.item_data.name")
catalog_objectItem_dataDescription = jResp.stringOf("catalog_object.item_data.description")
catalog_objectItem_dataAbbreviation = jResp.stringOf("catalog_object.item_data.abbreviation")
i = 0
count_i = jResp.SizeOfArray("id_mappings")
while i < count_i
    jResp.put_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
end