(Delphi DLL) Square API - Search Catalog Objects

Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,

Note: This example requires Chilkat v11.0.0 or greater.

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

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, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
json: HCkJsonObject;
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;
item_dataProduct_type: PWideChar;
item_dataVisibility: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
item_variation_dataItem_id: PWideChar;
item_variation_dataName: PWideChar;
item_variation_dataOrdinal: Integer;
item_variation_dataPrice_moneyAmount: Integer;
item_variation_dataPrice_moneyCurrency: PWideChar;
item_variation_dataPricing_type: PWideChar;
i: Integer;
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/search \
//   -X POST \
//   -H 'Square-Version: 2020-07-22' \
//   -H 'Authorization: Bearer ACCESS_TOKEN' \
//   -H 'Content-Type: application/json' \
//   -d '{
//     "object_types": [
//       "ITEM"
//     ],
//     "query": {
//       "prefix_query": {
//         "attribute_name": "name",
//         "attribute_prefix": "tea"
//       }
//     },
//     "limit": 100
//   }'

// 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_types": [
//     "ITEM"
//   ],
//   "query": {
//     "prefix_query": {
//       "attribute_name": "name",
//       "attribute_prefix": "tea"
//     }
//   },
//   "limit": 100
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'object_types[0]','ITEM');
CkJsonObject_UpdateString(json,'query.prefix_query.attribute_name','name');
CkJsonObject_UpdateString(json,'query.prefix_query.attribute_prefix','tea');
CkJsonObject_UpdateInt(json,'limit',100);

// 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/search',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": "X5DZ5NWWAQ44CKBLKIFQGOWK",
//       "updated_at": "2017-10-26T15:41:32.337Z",
//       "version": 1509032492337,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "item_data": {
//         "name": "Tea - Black",
//         "description": "A delicious blend of black tea.",
//         "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
//         "product_type": "REGULAR",
//         "tax_ids": [
//           "ZXITPM6RWHZ7GZ7EIP3YKECM"
//         ],
//         "variations": [
//           {
//             "type": "ITEM_VARIATION",
//             "id": "5GSZPX6EU7MM75S57OONG3V5",
//             "updated_at": "2017-10-26T15:27:31.626Z",
//             "version": 1509031651626,
//             "is_deleted": false,
//             "present_at_all_locations": true,
//             "item_variation_data": {
//               "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
//               "name": "Regular",
//               "ordinal": 1,
//               "price_money": {
//                 "amount": 150,
//                 "currency": "USD"
//               },
//               "pricing_type": "FIXED_PRICING"
//             }
//           },
//           {
//             "type": "ITEM_VARIATION",
//             "id": "XVLBN7DU6JTWHJTG5F265B43",
//             "updated_at": "2017-10-26T15:27:31.626Z",
//             "version": 1509031651626,
//             "is_deleted": false,
//             "present_at_all_locations": true,
//             "item_variation_data": {
//               "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
//               "name": "Large",
//               "ordinal": 2,
//               "price_money": {
//                 "amount": 225,
//                 "currency": "USD"
//               },
//               "pricing_type": "FIXED_PRICING"
//             }
//           }
//         ],
//         "visibility": "PRIVATE"
//       }
//     },
//     {
//       "type": "ITEM",
//       "id": "NNNEM3LA656Q46NXLWCNI7S5",
//       "updated_at": "2017-10-26T15:41:23.232Z",
//       "version": 1509032483232,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "item_data": {
//         "name": "Tea - Green",
//         "description": "Relaxing green herbal tea.",
//         "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
//         "product_type": "REGULAR",
//         "tax_ids": [
//           "ZXITPM6RWHZ7GZ7EIP3YKECM"
//         ],
//         "variations": [
//           {
//             "type": "ITEM_VARIATION",
//             "id": "FHYBVIA6NVBCSOVETA62WEA4",
//             "updated_at": "2017-10-26T15:29:00.524Z",
//             "version": 1509031740524,
//             "is_deleted": false,
//             "present_at_all_locations": true,
//             "item_variation_data": {
//               "item_id": "NNNEM3LA656Q46NXLWCNI7S5",
//               "name": "Regular",
//               "ordinal": 1,
//               "price_money": {
//                 "amount": 150,
//                 "currency": "USD"
//               },
//               "pricing_type": "FIXED_PRICING"
//             }
//           }
//         ],
//         "visibility": "PRIVATE"
//       }
//     }
//   ]
// }

// 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');
    item_dataProduct_type := CkJsonObject__stringOf(jResp,'objects[i].item_data.product_type');
    item_dataVisibility := CkJsonObject__stringOf(jResp,'objects[i].item_data.visibility');
    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_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');
        item_variation_dataPricing_type := CkJsonObject__stringOf(jResp,'objects[i].item_data.variations[j].item_variation_data.pricing_type');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkHttpResponse_Dispose(resp);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;