Dart

Square API - List Catalog

See more Square Examples

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog. 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/list?types=category%2Ctax \
  //   -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
  final sbResponseBody = CkStringBuilder();
  try {
    http.quickGetSb('https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image', sbResponseBody);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

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

  final respStatusCode = http.lastStatus;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(http.lastHeader);
    print('Failed.');
    return;
  }

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

  // {
  //   "objects": [
  //     {
  //       "type": "CATEGORY",
  //       "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
  //       "updated_at": "2017-02-21T14:50:26.495Z",
  //       "version": 1487688626495,
  //       "is_deleted": false,
  //       "present_at_all_locations": true,
  //       "category_data": {
  //         "name": "Beverages"
  //       }
  //     },
  //     {
  //       "type": "TAX",
  //       "id": "L5R47DGBZOOVKCAFIXC56AEN",
  //       "updated_at": "2017-02-21T14:50:26.495Z",
  //       "version": 1487688626495,
  //       "is_deleted": false,
  //       "present_at_all_locations": true,
  //       "tax_data": {
  //         "name": "Sales Tax",
  //         "calculation_phase": "TAX_SUBTOTAL_PHASE",
  //         "inclusion_type": "ADDITIVE",
  //         "percentage": "5.0",
  //         "enabled": true
  //       }
  //     }
  //   ]
  // }

  // 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 vType = '';
  var id = '';
  var updatedAt = '';
  var version = 0;
  var categoryDataName = '';
  var taxDataName = '';
  var taxDataCalculationPhase = '';
  var taxDataInclusionType = '';
  var taxDataPercentage = '';

  var i = 0;
  final countI = jResp.sizeOfArray('objects');
  while (i < countI) {
    jResp.i = i;
    vType = jResp.stringOf('objects[i].type');
    id = jResp.stringOf('objects[i].id');
    updatedAt = jResp.stringOf('objects[i].updated_at');
    version = jResp.intOf('objects[i].version');
    jResp.boolOf('objects[i].is_deleted');
    jResp.boolOf('objects[i].present_at_all_locations');
    categoryDataName = jResp.stringOf('objects[i].category_data.name');
    taxDataName = jResp.stringOf('objects[i].tax_data.name');
    taxDataCalculationPhase = jResp.stringOf('objects[i].tax_data.calculation_phase');
    taxDataInclusionType = jResp.stringOf('objects[i].tax_data.inclusion_type');
    taxDataPercentage = jResp.stringOf('objects[i].tax_data.percentage');
    jResp.boolOf('objects[i].tax_data.enabled');
    i++;
  }
}