Delphi DLL
Delphi DLL
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat Delphi DLL Downloads
uses
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, HttpResponse, JsonObject;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
json: HCkJsonObject;
i: Integer;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_type: PWideChar;
id: PWideChar;
updated_at: PWideChar;
version: Integer;
is_deleted: Boolean;
present_at_all_locations: Boolean;
item_dataName: PWideChar;
item_dataDescription: PWideChar;
item_dataCategory_id: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
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;
count_i: Integer;
begin
success := False;
// 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/batch-retrieve \
// -X POST \
// -H 'Square-Version: 2020-07-22' \
// -H 'Authorization: Bearer ACCESS_TOKEN' \
// -H 'Content-Type: application/json' \
// -d '{
// "object_ids": [
// "W62UWFY35CWMYGVWK6TWJDNI",
// "AA27W3M2GGTF3H6AVPNB77CK"
// ],
// "include_related_objects": true
// }'
// 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"
// ],
// "include_related_objects": true
// }
json := CkJsonObject_Create();
i := 0;
CkJsonObject_putI(json,i);
CkJsonObject_UpdateString(json,'object_ids[i]','W62UWFY35CWMYGVWK6TWJDNI');
i := i + 1;
CkJsonObject_putI(json,i);
CkJsonObject_UpdateString(json,'object_ids[i]','AA27W3M2GGTF3H6AVPNB77CK');
CkJsonObject_UpdateBool(json,'include_related_objects',True);
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
CkHttp_putAuthToken(http,'ACCESS_TOKEN');
CkHttp_SetRequestHeader(http,'Square-Version','2020-07-22');
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
resp := CkHttpResponse_Create();
success := CkHttp_HttpJson(http,'POST','https://connect.squareupsandbox.com/v2/catalog/batch-retrieve',json,'application/json',resp);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "objects": [
// {
// "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"
// }
// }
// }
// ]
// }
// },
// {
// "type": "ITEM",
// "id": "AA27W3M2GGTF3H6AVPNB77CK",
// "updated_at": "2016-11-16T22:25:24.878Z",
// "version": 1479335124878,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_data": {
// "name": "Coffee",
// "description": "Hot Bean Juice",
// "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
// "tax_ids": [
// "HURXQOOAIC4IZSI2BEXQRYFY"
// ],
// "variations": [
// {
// "type": "ITEM_VARIATION",
// "id": "LBTYIHNHU52WOIHWT7SNRIYH",
// "updated_at": "2016-11-16T22:25:24.878Z",
// "version": 1479335124878,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
// "name": "Regular",
// "ordinal": 0,
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 250,
// "currency": "USD"
// }
// }
// },
// {
// "type": "ITEM_VARIATION",
// "id": "PKYIC7HGGKW5CYVSCVDEIMHY",
// "updated_at": "2016-11-16T22:25:24.878Z",
// "version": 1479335124878,
// "is_deleted": false,
// "present_at_all_locations": true,
// "item_variation_data": {
// "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
// "name": "Large",
// "ordinal": 1,
// "pricing_type": "FIXED_PRICING",
// "price_money": {
// "amount": 350,
// "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
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'objects');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
v_type := CkJsonObject__stringOf(jResp,'objects[i].type');
id := CkJsonObject__stringOf(jResp,'objects[i].id');
updated_at := CkJsonObject__stringOf(jResp,'objects[i].updated_at');
version := CkJsonObject_IntOf(jResp,'objects[i].version');
is_deleted := CkJsonObject_BoolOf(jResp,'objects[i].is_deleted');
present_at_all_locations := CkJsonObject_BoolOf(jResp,'objects[i].present_at_all_locations');
item_dataName := CkJsonObject__stringOf(jResp,'objects[i].item_data.name');
item_dataDescription := CkJsonObject__stringOf(jResp,'objects[i].item_data.description');
item_dataCategory_id := CkJsonObject__stringOf(jResp,'objects[i].item_data.category_id');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'objects[i].item_data.tax_ids');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'objects[i].item_data.tax_ids[j]');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'objects[i].item_data.variations');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
v_type := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].type');
id := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].id');
updated_at := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].updated_at');
version := CkJsonObject_IntOf(jResp,'objects[i].item_data.variations[j].version');
is_deleted := CkJsonObject_BoolOf(jResp,'objects[i].item_data.variations[j].is_deleted');
present_at_all_locations := CkJsonObject_BoolOf(jResp,'objects[i].item_data.variations[j].present_at_all_locations');
item_variation_dataItem_id := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].item_variation_data.item_id');
item_variation_dataName := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].item_variation_data.name');
item_variation_dataOrdinal := CkJsonObject_IntOf(jResp,'objects[i].item_data.variations[j].item_variation_data.ordinal');
item_variation_dataPricing_type := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].item_variation_data.pricing_type');
item_variation_dataPrice_moneyAmount := CkJsonObject_IntOf(jResp,'objects[i].item_data.variations[j].item_variation_data.price_money.amount');
item_variation_dataPrice_moneyCurrency := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].item_variation_data.price_money.currency');
j := j + 1;
end;
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);
CkJsonObject_Dispose(json);
CkHttpResponse_Dispose(resp);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
end;