(Delphi ActiveX) Square API - List Catalog

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.

For more information, see https://developer.squareup.com/reference/square/catalog-api/list-catalog

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_type: WideString;
id: WideString;
updated_at: WideString;
version: Integer;
is_deleted: Integer;
present_at_all_locations: Integer;
category_dataName: WideString;
tax_dataName: WideString;
tax_dataCalculation_phase: WideString;
tax_dataInclusion_type: WideString;
tax_dataPercentage: WideString;
tax_dataEnabled: Integer;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

// 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
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

i := 0;
count_i := jResp.SizeOfArray('objects');
while i < count_i do
  begin
    jResp.I := i;
    v_type := jResp.StringOf('objects[i].type');
    id := jResp.StringOf('objects[i].id');
    updated_at := jResp.StringOf('objects[i].updated_at');
    version := jResp.IntOf('objects[i].version');
    is_deleted := jResp.BoolOf('objects[i].is_deleted');
    present_at_all_locations := jResp.BoolOf('objects[i].present_at_all_locations');
    category_dataName := jResp.StringOf('objects[i].category_data.name');
    tax_dataName := jResp.StringOf('objects[i].tax_data.name');
    tax_dataCalculation_phase := jResp.StringOf('objects[i].tax_data.calculation_phase');
    tax_dataInclusion_type := jResp.StringOf('objects[i].tax_data.inclusion_type');
    tax_dataPercentage := jResp.StringOf('objects[i].tax_data.percentage');
    tax_dataEnabled := jResp.BoolOf('objects[i].tax_data.enabled');
    i := i + 1;
  end;
end;