(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

int i;
int j;
int k;

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"idempotency_key" value: @"789ff020-f723-43a9-b4b5-43b5dc1fa3dc"];
i = 0;
json.I = [NSNumber numberWithInt: i];
j = 0;
json.J = [NSNumber numberWithInt: j];
[json UpdateString: @"batches[i].objects[j].type" value: @"ITEM"];
[json UpdateString: @"batches[i].objects[j].id" value: @"#Tea"];
[json UpdateBool: @"batches[i].objects[j].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].item_data.name" value: @"Tea"];
[json UpdateString: @"batches[i].objects[j].item_data.description" value: @"Hot Leaf Juice"];
[json UpdateString: @"batches[i].objects[j].item_data.category_id" value: @"#Beverages"];
[json UpdateString: @"batches[i].objects[j].item_data.tax_ids[0]" value: @"#SalesTax"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[0].type" value: @"ITEM_VARIATION"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[0].id" value: @"#Tea_Mug"];
[json UpdateBool: @"batches[i].objects[j].item_data.variations[0].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].item_data.variations[0].item_variation_data.item_id" value: @"#Tea"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[0].item_variation_data.name" value: @"Mug"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type" value: @"FIXED_PRICING"];
[json UpdateInt: @"batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount" value: [NSNumber numberWithInt: 150]];
[json UpdateString: @"batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency" value: @"USD"];
j = j + 1;
json.J = [NSNumber numberWithInt: j];
[json UpdateString: @"batches[i].objects[j].type" value: @"ITEM"];
[json UpdateString: @"batches[i].objects[j].id" value: @"#Coffee"];
[json UpdateBool: @"batches[i].objects[j].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].item_data.name" value: @"Coffee"];
[json UpdateString: @"batches[i].objects[j].item_data.description" value: @"Hot Bean Juice"];
[json UpdateString: @"batches[i].objects[j].item_data.category_id" value: @"#Beverages"];
[json UpdateString: @"batches[i].objects[j].item_data.tax_ids[0]" value: @"#SalesTax"];
k = 0;
json.K = [NSNumber numberWithInt: k];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].type" value: @"ITEM_VARIATION"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].id" value: @"#Coffee_Regular"];
[json UpdateBool: @"batches[i].objects[j].item_data.variations[k].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.item_id" value: @"#Coffee"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.name" value: @"Regular"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type" value: @"FIXED_PRICING"];
[json UpdateInt: @"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount" value: [NSNumber numberWithInt: 250]];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency" value: @"USD"];
k = k + 1;
json.K = [NSNumber numberWithInt: k];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].type" value: @"ITEM_VARIATION"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].id" value: @"#Coffee_Large"];
[json UpdateBool: @"batches[i].objects[j].item_data.variations[k].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.item_id" value: @"#Coffee"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.name" value: @"Large"];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type" value: @"FIXED_PRICING"];
[json UpdateInt: @"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount" value: [NSNumber numberWithInt: 350]];
[json UpdateString: @"batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency" value: @"USD"];
j = j + 1;
json.J = [NSNumber numberWithInt: j];
[json UpdateString: @"batches[i].objects[j].type" value: @"CATEGORY"];
[json UpdateString: @"batches[i].objects[j].id" value: @"#Beverages"];
[json UpdateBool: @"batches[i].objects[j].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].category_data.name" value: @"Beverages"];
j = j + 1;
json.J = [NSNumber numberWithInt: j];
[json UpdateString: @"batches[i].objects[j].type" value: @"TAX"];
[json UpdateString: @"batches[i].objects[j].id" value: @"#SalesTax"];
[json UpdateBool: @"batches[i].objects[j].present_at_all_locations" value: YES];
[json UpdateString: @"batches[i].objects[j].tax_data.name" value: @"Sales Tax"];
[json UpdateString: @"batches[i].objects[j].tax_data.calculation_phase" value: @"TAX_SUBTOTAL_PHASE"];
[json UpdateString: @"batches[i].objects[j].tax_data.inclusion_type" value: @"ADDITIVE"];
[json UpdateString: @"batches[i].objects[j].tax_data.percentage" value: @"5.0"];
[json UpdateBool: @"batches[i].objects[j].tax_data.applies_to_custom_amounts" value: YES];
[json UpdateBool: @"batches[i].objects[j].tax_data.enabled" value: YES];

// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.AuthToken = @"ACCESS_TOKEN";
[http SetRequestHeader: @"Square-Version" value: @"2020-07-22"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
CkoHttpResponse *resp = [http PostJson3: @"https://connect.squareupsandbox.com/v2/catalog/batch-upsert" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *v_type = 0;
NSString *id = 0;
NSString *updated_at = 0;
int version;
BOOL is_deleted;
BOOL present_at_all_locations;
NSString *item_dataName = 0;
NSString *item_dataDescription = 0;
NSString *item_dataCategory_id = 0;
NSString *category_dataName = 0;
NSString *tax_dataName = 0;
NSString *tax_dataCalculation_phase = 0;
NSString *tax_dataInclusion_type = 0;
NSString *tax_dataPercentage = 0;
BOOL tax_dataApplies_to_custom_amounts;
BOOL tax_dataEnabled;
int count_j;
NSString *strVal = 0;
NSString *item_variation_dataItem_id = 0;
NSString *item_variation_dataName = 0;
int item_variation_dataOrdinal;
NSString *item_variation_dataPricing_type = 0;
int item_variation_dataPrice_moneyAmount;
NSString *item_variation_dataPrice_moneyCurrency = 0;
NSString *client_object_id = 0;
NSString *object_id = 0;

i = 0;
int count_i = [[jResp SizeOfArray: @"objects"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: 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"] intValue];
    is_deleted = [jResp BoolOf: @"objects[i].is_deleted"];
    present_at_all_locations = [jResp BoolOf: @"objects[i].present_at_all_locations"];
    item_dataName = [jResp StringOf: @"objects[i].item_data.name"];
    item_dataDescription = [jResp StringOf: @"objects[i].item_data.description"];
    item_dataCategory_id = [jResp StringOf: @"objects[i].item_data.category_id"];
    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_dataApplies_to_custom_amounts = [jResp BoolOf: @"objects[i].tax_data.applies_to_custom_amounts"];
    tax_dataEnabled = [jResp BoolOf: @"objects[i].tax_data.enabled"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"objects[i].item_data.tax_ids"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        strVal = [jResp StringOf: @"objects[i].item_data.tax_ids[j]"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"objects[i].item_data.variations"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        v_type = [jResp StringOf: @"objects[i].item_data.variations[j].type"];
        id = [jResp StringOf: @"objects[i].item_data.variations[j].id"];
        updated_at = [jResp StringOf: @"objects[i].item_data.variations[j].updated_at"];
        version = [[jResp IntOf: @"objects[i].item_data.variations[j].version"] intValue];
        is_deleted = [jResp BoolOf: @"objects[i].item_data.variations[j].is_deleted"];
        present_at_all_locations = [jResp BoolOf: @"objects[i].item_data.variations[j].present_at_all_locations"];
        item_variation_dataItem_id = [jResp StringOf: @"objects[i].item_data.variations[j].item_variation_data.item_id"];
        item_variation_dataName = [jResp StringOf: @"objects[i].item_data.variations[j].item_variation_data.name"];
        item_variation_dataOrdinal = [[jResp IntOf: @"objects[i].item_data.variations[j].item_variation_data.ordinal"] intValue];
        item_variation_dataPricing_type = [jResp StringOf: @"objects[i].item_data.variations[j].item_variation_data.pricing_type"];
        item_variation_dataPrice_moneyAmount = [[jResp IntOf: @"objects[i].item_data.variations[j].item_variation_data.price_money.amount"] intValue];
        item_variation_dataPrice_moneyCurrency = [jResp StringOf: @"objects[i].item_data.variations[j].item_variation_data.price_money.currency"];
        j = j + 1;
    }

    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"id_mappings"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    client_object_id = [jResp StringOf: @"id_mappings[i].client_object_id"];
    object_id = [jResp StringOf: @"id_mappings[i].object_id"];
    i = i + 1;
}