PHP Extension

Square API - Batch Delete Catalog Objects

See more Square Examples

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$http = new CkHttp();

// Implements the following CURL command:

// curl https://connect.squareup.com/v2/catalog/batch-delete \
//   -X POST \
//   -H 'Square-Version: 2020-07-22' \
//   -H 'Authorization: Bearer ACCESS_TOKEN' \
//   -H 'Content-Type: application/json' \
//   -d '{
//     "object_ids": [
//       "W62UWFY35CWMYGVWK6TWJDNI",
//       "AA27W3M2GGTF3H6AVPNB77CK"
//     ]
//   }'

// 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_ids": [
//     "W62UWFY35CWMYGVWK6TWJDNI",
//     "AA27W3M2GGTF3H6AVPNB77CK"
//   ]
// }

$json = new CkJsonObject();
$i = 0;
$json->put_I($i);
$json->UpdateString('object_ids[i]','W62UWFY35CWMYGVWK6TWJDNI');
$i = $i + 1;
$json->put_I($i);
$json->UpdateString('object_ids[i]','AA27W3M2GGTF3H6AVPNB77CK');

// 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 = new CkHttpResponse();
$success = $http->HttpJson('POST','https://connect.squareupsandbox.com/v2/catalog/batch-delete',$json,'application/json',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

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

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

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

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "deleted_object_ids": [
//     "W62UWFY35CWMYGVWK6TWJDNI",
//     "AA27W3M2GGTF3H6AVPNB77CK"
//   ],
//   "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

$deleted_at = $jResp->stringOf('deleted_at');
$i = 0;
$count_i = $jResp->SizeOfArray('deleted_object_ids');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('deleted_object_ids[i]');
    $i = $i + 1;
}


?>