Sample code for 30+ languages & platforms
Perl

Upsert Catalog Object

See more Square Examples

Creates or updates the target CatalogObject.

Chilkat Perl Downloads

Perl
use chilkat();

$success = 0;

# 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 == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

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