Dart

Square API - Delete Catalog Object

See more Square Examples

Deletes a single CatalogObject based on the provided ID and returns the 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/object/object_id0 \
  //   -X DELETE \
  //   -H 'Square-Version: 2020-07-22' \
  //   -H 'Authorization: Bearer ACCESS_TOKEN' \
  //   -H 'Content-Type: application/json'

  // Use the following online tool to generate HTTP code from a CURL command
  // Convert a cURL Command to HTTP Source Code

  // Adds the "Authorization: Bearer ACCESS_TOKEN" header.
  http.authToken = 'ACCESS_TOKEN';
  http.setRequestHeader('Square-Version', '2020-07-22');
  http.setRequestHeader('Content-Type', 'application/json');

  // This example uses the sandbox: connect.squareupsandbox.com
  // Production should use connect.squareup.com

  http.setUrlVar('object_id', '2PTZYUOFGGDMT75UZLHQAPAC');
  final resp = CkHttpResponse();
  try {
    http.httpNoBody('DELETE', 'https://connect.squareupsandbox.com/v2/catalog/object/{\$object_id}', 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": [
  //     "2PTZYUOFGGDMT75UZLHQAPAC",
  //     "KQLFFHA6K6J3YQAQAWDQAL57"
  //   ],
  //   "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');
  var i = 0;
  final countI = jResp.sizeOfArray('deleted_object_ids');
  while (i < countI) {
    jResp.i = i;
    strVal = jResp.stringOf('deleted_object_ids[i]');
    i++;
  }
}