Dart

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

import 'package:chilkat/chilkat.dart';

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

  final http = 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"
  //   ]
  // }

  final json = CkJsonObject();
  var i = 0;
  json.i = i;
  json.updateString('object_ids[i]', 'W62UWFY35CWMYGVWK6TWJDNI');
  i++;
  json.i = i;
  json.updateString('object_ids[i]', 'AA27W3M2GGTF3H6AVPNB77CK');

  // 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
  final resp = CkHttpResponse();
  try {
    http.httpJson('POST', 'https://connect.squareupsandbox.com/v2/catalog/batch-delete', json, 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);
  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('Failed.');
    return;
  }

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

  var strVal = '';

  final deletedAt = jResp.stringOf('deleted_at');
  i = 0;
  final countI = jResp.sizeOfArray('deleted_object_ids');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deleted_object_ids[i]');
    i++;
  }
}