(Delphi DLL) Square API - Retrieve Catalog Object

Returns a single CatalogItem as a CatalogObject based on the provided ID.

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

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

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
v_type: PWideChar;
id: PWideChar;
updated_at: PWideChar;
version: Integer;
is_deleted: Boolean;
present_at_all_locations: Boolean;
item_variation_dataItem_id: PWideChar;
item_variation_dataName: PWideChar;
item_variation_dataOrdinal: Integer;
item_variation_dataPricing_type: PWideChar;
item_variation_dataPrice_moneyAmount: Integer;
item_variation_dataPrice_moneyCurrency: PWideChar;
category_dataName: PWideChar;
tax_dataName: PWideChar;
tax_dataCalculation_phase: PWideChar;
tax_dataInclusion_type: PWideChar;
tax_dataPercentage: PWideChar;
tax_dataEnabled: Boolean;
objectType: PWideChar;
objectId: PWideChar;
objectUpdated_at: PWideChar;
objectVersion: Integer;
objectIs_deleted: Boolean;
objectPresent_at_all_locations: Boolean;
objectItem_dataName: PWideChar;
objectItem_dataDescription: PWideChar;
objectItem_dataCategory_id: PWideChar;
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 := CkHttp_Create();

// Implements the following CURL command:

// curl https://connect.squareup.com/v2/catalog/object/W62UWFY35CWMYGVWK6TWJDNI?include_related_objects=true 
//   -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.
CkHttp_putAuthToken(http,'ACCESS_TOKEN');
CkHttp_SetRequestHeader(http,'Square-Version','2020-07-22');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

CkHttp_SetUrlVar(http,'id','2PTZYUOFGGDMT75UZLHQAPAC');

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

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

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

// {
//   "object": {
//     "type": "ITEM",
//     "id": "W62UWFY35CWMYGVWK6TWJDNI",
//     "updated_at": "2016-11-16T22:25:24.878Z",
//     "version": 1479335124878,
//     "is_deleted": false,
//     "present_at_all_locations": true,
//     "item_data": {
//       "name": "Tea",
//       "description": "Hot Leaf Juice",
//       "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
//       "tax_ids": [
//         "HURXQOOAIC4IZSI2BEXQRYFY"
//       ],
//       "variations": [
//         {
//           "type": "ITEM_VARIATION",
//           "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
//           "updated_at": "2016-11-16T22:25:24.878Z",
//           "version": 1479335124878,
//           "is_deleted": false,
//           "present_at_all_locations": true,
//           "item_variation_data": {
//             "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
//             "name": "Mug",
//             "ordinal": 0,
//             "pricing_type": "FIXED_PRICING",
//             "price_money": {
//               "amount": 150,
//               "currency": "USD"
//             }
//           }
//         }
//       ]
//     }
//   },
//   "related_objects": [
//     {
//       "type": "CATEGORY",
//       "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
//       "updated_at": "2016-11-16T22:25:24.878Z",
//       "version": 1479335124878,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "category_data": {
//         "name": "Beverages"
//       }
//     },
//     {
//       "type": "TAX",
//       "id": "HURXQOOAIC4IZSI2BEXQRYFY",
//       "updated_at": "2016-11-16T22:25:24.878Z",
//       "version": 1479335124878,
//       "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

objectType := CkJsonObject__stringOf(jResp,'object.type');
objectId := CkJsonObject__stringOf(jResp,'object.id');
objectUpdated_at := CkJsonObject__stringOf(jResp,'object.updated_at');
objectVersion := CkJsonObject_IntOf(jResp,'object.version');
objectIs_deleted := CkJsonObject_BoolOf(jResp,'object.is_deleted');
objectPresent_at_all_locations := CkJsonObject_BoolOf(jResp,'object.present_at_all_locations');
objectItem_dataName := CkJsonObject__stringOf(jResp,'object.item_data.name');
objectItem_dataDescription := CkJsonObject__stringOf(jResp,'object.item_data.description');
objectItem_dataCategory_id := CkJsonObject__stringOf(jResp,'object.item_data.category_id');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'object.item_data.tax_ids');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'object.item_data.tax_ids[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'object.item_data.variations');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    v_type := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].type');
    id := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].id');
    updated_at := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].updated_at');
    version := CkJsonObject_IntOf(jResp,'object.item_data.variations[i].version');
    is_deleted := CkJsonObject_BoolOf(jResp,'object.item_data.variations[i].is_deleted');
    present_at_all_locations := CkJsonObject_BoolOf(jResp,'object.item_data.variations[i].present_at_all_locations');
    item_variation_dataItem_id := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].item_variation_data.item_id');
    item_variation_dataName := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].item_variation_data.name');
    item_variation_dataOrdinal := CkJsonObject_IntOf(jResp,'object.item_data.variations[i].item_variation_data.ordinal');
    item_variation_dataPricing_type := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].item_variation_data.pricing_type');
    item_variation_dataPrice_moneyAmount := CkJsonObject_IntOf(jResp,'object.item_data.variations[i].item_variation_data.price_money.amount');
    item_variation_dataPrice_moneyCurrency := CkJsonObject__stringOf(jResp,'object.item_data.variations[i].item_variation_data.price_money.currency');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'related_objects');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    v_type := CkJsonObject__stringOf(jResp,'related_objects[i].type');
    id := CkJsonObject__stringOf(jResp,'related_objects[i].id');
    updated_at := CkJsonObject__stringOf(jResp,'related_objects[i].updated_at');
    version := CkJsonObject_IntOf(jResp,'related_objects[i].version');
    is_deleted := CkJsonObject_BoolOf(jResp,'related_objects[i].is_deleted');
    present_at_all_locations := CkJsonObject_BoolOf(jResp,'related_objects[i].present_at_all_locations');
    category_dataName := CkJsonObject__stringOf(jResp,'related_objects[i].category_data.name');
    tax_dataName := CkJsonObject__stringOf(jResp,'related_objects[i].tax_data.name');
    tax_dataCalculation_phase := CkJsonObject__stringOf(jResp,'related_objects[i].tax_data.calculation_phase');
    tax_dataInclusion_type := CkJsonObject__stringOf(jResp,'related_objects[i].tax_data.inclusion_type');
    tax_dataPercentage := CkJsonObject__stringOf(jResp,'related_objects[i].tax_data.percentage');
    tax_dataEnabled := CkJsonObject_BoolOf(jResp,'related_objects[i].tax_data.enabled');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;