(Delphi DLL) Square API - Batch Upsert Catalog Objects

Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner.

For more information, see https://developer.squareup.com/reference/square/catalog-api/batch-upsert-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
http: HCkHttp;
success: Boolean;
i: Integer;
j: Integer;
k: Integer;
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;
category_dataName: PWideChar;
tax_dataName: PWideChar;
tax_dataCalculation_phase: PWideChar;
tax_dataInclusion_type: PWideChar;
tax_dataPercentage: PWideChar;
tax_dataApplies_to_custom_amounts: Boolean;
tax_dataEnabled: Boolean;
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;
client_object_id: PWideChar;
object_id: PWideChar;
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();

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "idempotency_key": "789ff020-f723-43a9-b4b5-43b5dc1fa3dc",
//   "batches": [
//     {
//       "objects": [
//         {
//           "type": "ITEM",
//           "id": "#Tea",
//           "present_at_all_locations": true,
//           "item_data": {
//             "name": "Tea",
//             "description": "Hot Leaf Juice",
//             "category_id": "#Beverages",
//             "tax_ids": [
//               "#SalesTax"
//             ],
//             "variations": [
//               {
//                 "type": "ITEM_VARIATION",
//                 "id": "#Tea_Mug",
//                 "present_at_all_locations": true,
//                 "item_variation_data": {
//                   "item_id": "#Tea",
//                   "name": "Mug",
//                   "pricing_type": "FIXED_PRICING",
//                   "price_money": {
//                     "amount": 150,
//                     "currency": "USD"
//                   }
//                 }
//               }
//             ]
//           }
//         },
//         {
//           "type": "ITEM",
//           "id": "#Coffee",
//           "present_at_all_locations": true,
//           "item_data": {
//             "name": "Coffee",
//             "description": "Hot Bean Juice",
//             "category_id": "#Beverages",
//             "tax_ids": [
//               "#SalesTax"
//             ],
//             "variations": [
//               {
//                 "type": "ITEM_VARIATION",
//                 "id": "#Coffee_Regular",
//                 "present_at_all_locations": true,
//                 "item_variation_data": {
//                   "item_id": "#Coffee",
//                   "name": "Regular",
//                   "pricing_type": "FIXED_PRICING",
//                   "price_money": {
//                     "amount": 250,
//                     "currency": "USD"
//                   }
//                 }
//               },
//               {
//                 "type": "ITEM_VARIATION",
//                 "id": "#Coffee_Large",
//                 "present_at_all_locations": true,
//                 "item_variation_data": {
//                   "item_id": "#Coffee",
//                   "name": "Large",
//                   "pricing_type": "FIXED_PRICING",
//                   "price_money": {
//                     "amount": 350,
//                     "currency": "USD"
//                   }
//                 }
//               }
//             ]
//           }
//         },
//         {
//           "type": "CATEGORY",
//           "id": "#Beverages",
//           "present_at_all_locations": true,
//           "category_data": {
//             "name": "Beverages"
//           }
//         },
//         {
//           "type": "TAX",
//           "id": "#SalesTax",
//           "present_at_all_locations": true,
//           "tax_data": {
//             "name": "Sales Tax",
//             "calculation_phase": "TAX_SUBTOTAL_PHASE",
//             "inclusion_type": "ADDITIVE",
//             "percentage": "5.0",
//             "applies_to_custom_amounts": true,
//             "enabled": true
//           }
//         }
//       ]
//     }
//   ]
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'idempotency_key','789ff020-f723-43a9-b4b5-43b5dc1fa3dc');
i := 0;
CkJsonObject_putI(json,i);
j := 0;
CkJsonObject_putJ(json,j);
CkJsonObject_UpdateString(json,'batches[i].objects[j].type','ITEM');
CkJsonObject_UpdateString(json,'batches[i].objects[j].id','#Tea');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.name','Tea');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.description','Hot Leaf Juice');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.category_id','#Beverages');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.tax_ids[0]','#SalesTax');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[0].type','ITEM_VARIATION');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[0].id','#Tea_Mug');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].item_data.variations[0].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[0].item_variation_data.item_id','#Tea');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[0].item_variation_data.name','Mug');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type','FIXED_PRICING');
CkJsonObject_UpdateInt(json,'batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount',150);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency','USD');
j := j + 1;
CkJsonObject_putJ(json,j);
CkJsonObject_UpdateString(json,'batches[i].objects[j].type','ITEM');
CkJsonObject_UpdateString(json,'batches[i].objects[j].id','#Coffee');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.name','Coffee');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.description','Hot Bean Juice');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.category_id','#Beverages');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.tax_ids[0]','#SalesTax');
k := 0;
CkJsonObject_putK(json,k);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].type','ITEM_VARIATION');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].id','#Coffee_Regular');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].item_data.variations[k].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.item_id','#Coffee');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.name','Regular');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type','FIXED_PRICING');
CkJsonObject_UpdateInt(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount',250);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency','USD');
k := k + 1;
CkJsonObject_putK(json,k);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].type','ITEM_VARIATION');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].id','#Coffee_Large');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].item_data.variations[k].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.item_id','#Coffee');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.name','Large');
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type','FIXED_PRICING');
CkJsonObject_UpdateInt(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount',350);
CkJsonObject_UpdateString(json,'batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency','USD');
j := j + 1;
CkJsonObject_putJ(json,j);
CkJsonObject_UpdateString(json,'batches[i].objects[j].type','CATEGORY');
CkJsonObject_UpdateString(json,'batches[i].objects[j].id','#Beverages');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].category_data.name','Beverages');
j := j + 1;
CkJsonObject_putJ(json,j);
CkJsonObject_UpdateString(json,'batches[i].objects[j].type','TAX');
CkJsonObject_UpdateString(json,'batches[i].objects[j].id','#SalesTax');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].present_at_all_locations',True);
CkJsonObject_UpdateString(json,'batches[i].objects[j].tax_data.name','Sales Tax');
CkJsonObject_UpdateString(json,'batches[i].objects[j].tax_data.calculation_phase','TAX_SUBTOTAL_PHASE');
CkJsonObject_UpdateString(json,'batches[i].objects[j].tax_data.inclusion_type','ADDITIVE');
CkJsonObject_UpdateString(json,'batches[i].objects[j].tax_data.percentage','5.0');
CkJsonObject_UpdateBool(json,'batches[i].objects[j].tax_data.applies_to_custom_amounts',True);
CkJsonObject_UpdateBool(json,'batches[i].objects[j].tax_data.enabled',True);

// 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');

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
resp := CkHttp_PostJson3(http,'https://connect.squareupsandbox.com/v2/catalog/batch-upsert','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = 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.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

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

// {
//   "objects": [
//     {
//       "type": "ITEM",
//       "id": "ZSDZN34NAXDLC6D5ZQMNSOUM",
//       "updated_at": "2017-05-10T18:48:39.798Z",
//       "version": 1494442119798,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "item_data": {
//         "name": "Tea",
//         "description": "Hot Leaf Juice",
//         "category_id": "LYT72K3WGJFFCIMB63XARP3I",
//         "tax_ids": [
//           "XHSHLHNWSI3HVI4BW5ZUZXI3"
//         ],
//         "variations": [
//           {
//             "type": "ITEM_VARIATION",
//             "id": "NAYHET5R52MIYCEF34ZMAHFM",
//             "updated_at": "2017-05-10T18:48:39.798Z",
//             "version": 1494442119798,
//             "is_deleted": false,
//             "present_at_all_locations": true,
//             "item_variation_data": {
//               "item_id": "ZSDZN34NAXDLC6D5ZQMNSOUM",
//               "name": "Mug",
//               "ordinal": 0,
//               "pricing_type": "FIXED_PRICING",
//               "price_money": {
//                 "amount": 150,
//                 "currency": "USD"
//               }
//             }
//           }
//         ]
//       }
//     },
//     {
//       "type": "ITEM",
//       "id": "PJMCEBHHUS3OKDB6PYUHLCPP",
//       "updated_at": "2017-05-10T18:48:39.798Z",
//       "version": 1494442119798,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "item_data": {
//         "name": "Coffee",
//         "description": "Hot Bean Juice",
//         "category_id": "LYT72K3WGJFFCIMB63XARP3I",
//         "tax_ids": [
//           "XHSHLHNWSI3HVI4BW5ZUZXI3"
//         ],
//         "variations": [
//           {
//             "type": "ITEM_VARIATION",
//             "id": "OTYDX45SPG7LJQUVCBZI4INH",
//             "updated_at": "2017-05-10T18:48:39.798Z",
//             "version": 1494442119798,
//             "is_deleted": false,
//             "present_at_all_locations": true,
//             "item_variation_data": {
//               "item_id": "PJMCEBHHUS3OKDB6PYUHLCPP",
//               "name": "Regular",
//               "ordinal": 0,
//               "pricing_type": "FIXED_PRICING",
//               "price_money": {
//                 "amount": 250,
//                 "currency": "USD"
//               }
//             }
//           },
//           {
//             "type": "ITEM_VARIATION",
//             "id": "GZDA3JB37FYVOPI4AOEBOITI",
//             "updated_at": "2017-05-10T18:48:39.798Z",
//             "version": 1494442119798,
//             "is_deleted": false,
//             "present_at_all_locations": true,
//             "item_variation_data": {
//               "item_id": "PJMCEBHHUS3OKDB6PYUHLCPP",
//               "name": "Large",
//               "ordinal": 1,
//               "pricing_type": "FIXED_PRICING",
//               "price_money": {
//                 "amount": 350,
//                 "currency": "USD"
//               }
//             }
//           }
//         ]
//       }
//     },
//     {
//       "type": "CATEGORY",
//       "id": "LYT72K3WGJFFCIMB63XARP3I",
//       "updated_at": "2017-05-10T18:48:39.798Z",
//       "version": 1494442119798,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "category_data": {
//         "name": "Beverages"
//       }
//     },
//     {
//       "type": "TAX",
//       "id": "XHSHLHNWSI3HVI4BW5ZUZXI3",
//       "updated_at": "2017-05-10T18:48:39.798Z",
//       "version": 1494442119798,
//       "is_deleted": false,
//       "present_at_all_locations": true,
//       "tax_data": {
//         "name": "Sales Tax",
//         "calculation_phase": "TAX_SUBTOTAL_PHASE",
//         "inclusion_type": "ADDITIVE",
//         "percentage": "5.0",
//         "applies_to_custom_amounts": true,
//         "enabled": true
//       }
//     }
//   ],
//   "id_mappings": [
//     {
//       "client_object_id": "#Tea",
//       "object_id": "ZSDZN34NAXDLC6D5ZQMNSOUM"
//     },
//     {
//       "client_object_id": "#Coffee",
//       "object_id": "PJMCEBHHUS3OKDB6PYUHLCPP"
//     },
//     {
//       "client_object_id": "#Beverages",
//       "object_id": "LYT72K3WGJFFCIMB63XARP3I"
//     },
//     {
//       "client_object_id": "#SalesTax",
//       "object_id": "XHSHLHNWSI3HVI4BW5ZUZXI3"
//     },
//     {
//       "client_object_id": "#Tea_Mug",
//       "object_id": "NAYHET5R52MIYCEF34ZMAHFM"
//     },
//     {
//       "client_object_id": "#Coffee_Regular",
//       "object_id": "OTYDX45SPG7LJQUVCBZI4INH"
//     },
//     {
//       "client_object_id": "#Coffee_Large",
//       "object_id": "GZDA3JB37FYVOPI4AOEBOITI"
//     }
//   ]
// }

// 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');
    category_dataName := CkJsonObject__stringOf(jResp,'objects[i].category_data.name');
    tax_dataName := CkJsonObject__stringOf(jResp,'objects[i].tax_data.name');
    tax_dataCalculation_phase := CkJsonObject__stringOf(jResp,'objects[i].tax_data.calculation_phase');
    tax_dataInclusion_type := CkJsonObject__stringOf(jResp,'objects[i].tax_data.inclusion_type');
    tax_dataPercentage := CkJsonObject__stringOf(jResp,'objects[i].tax_data.percentage');
    tax_dataApplies_to_custom_amounts := CkJsonObject_BoolOf(jResp,'objects[i].tax_data.applies_to_custom_amounts');
    tax_dataEnabled := CkJsonObject_BoolOf(jResp,'objects[i].tax_data.enabled');
    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,'id_mappings');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    client_object_id := CkJsonObject__stringOf(jResp,'id_mappings[i].client_object_id');
    object_id := CkJsonObject__stringOf(jResp,'id_mappings[i].object_id');
    i := i + 1;
  end;

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

end;