Sample code for 30+ languages & platforms
Rust

Square API - Batch Upsert Catalog Objects

See more Square Examples

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.

Chilkat Rust Downloads

Rust

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

let http = chilkat::Http::new();

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

let mut i: i32 = 0;
let mut j: i32 = 0;
let mut k: i32 = 0;

let json = chilkat::JsonObject::new();
let _ = json.update_string("idempotency_key", "789ff020-f723-43a9-b4b5-43b5dc1fa3dc");
i = 0;
json.set_i(i);
j = 0;
json.set_j(j);
let _ = json.update_string("batches[i].objects[j].type", "ITEM");
let _ = json.update_string("batches[i].objects[j].id", "#Tea");
let _ = json.update_bool("batches[i].objects[j].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].item_data.name", "Tea");
let _ = json.update_string("batches[i].objects[j].item_data.description", "Hot Leaf Juice");
let _ = json.update_string("batches[i].objects[j].item_data.category_id", "#Beverages");
let _ = json.update_string("batches[i].objects[j].item_data.tax_ids[0]", "#SalesTax");
let _ = json.update_string("batches[i].objects[j].item_data.variations[0].type", "ITEM_VARIATION");
let _ = json.update_string("batches[i].objects[j].item_data.variations[0].id", "#Tea_Mug");
let _ = json.update_bool("batches[i].objects[j].item_data.variations[0].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].item_data.variations[0].item_variation_data.item_id", "#Tea");
let _ = json.update_string("batches[i].objects[j].item_data.variations[0].item_variation_data.name", "Mug");
let _ = json.update_string("batches[i].objects[j].item_data.variations[0].item_variation_data.pricing_type", "FIXED_PRICING");
let _ = json.update_int("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.amount", 150);
let _ = json.update_string("batches[i].objects[j].item_data.variations[0].item_variation_data.price_money.currency", "USD");
j = j + 1;
json.set_j(j);
let _ = json.update_string("batches[i].objects[j].type", "ITEM");
let _ = json.update_string("batches[i].objects[j].id", "#Coffee");
let _ = json.update_bool("batches[i].objects[j].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].item_data.name", "Coffee");
let _ = json.update_string("batches[i].objects[j].item_data.description", "Hot Bean Juice");
let _ = json.update_string("batches[i].objects[j].item_data.category_id", "#Beverages");
let _ = json.update_string("batches[i].objects[j].item_data.tax_ids[0]", "#SalesTax");
k = 0;
json.set_k(k);
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].type", "ITEM_VARIATION");
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].id", "#Coffee_Regular");
let _ = json.update_bool("batches[i].objects[j].item_data.variations[k].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id", "#Coffee");
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.name", "Regular");
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type", "FIXED_PRICING");
let _ = json.update_int("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount", 250);
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency", "USD");
k = k + 1;
json.set_k(k);
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].type", "ITEM_VARIATION");
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].id", "#Coffee_Large");
let _ = json.update_bool("batches[i].objects[j].item_data.variations[k].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.item_id", "#Coffee");
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.name", "Large");
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.pricing_type", "FIXED_PRICING");
let _ = json.update_int("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.amount", 350);
let _ = json.update_string("batches[i].objects[j].item_data.variations[k].item_variation_data.price_money.currency", "USD");
j = j + 1;
json.set_j(j);
let _ = json.update_string("batches[i].objects[j].type", "CATEGORY");
let _ = json.update_string("batches[i].objects[j].id", "#Beverages");
let _ = json.update_bool("batches[i].objects[j].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].category_data.name", "Beverages");
j = j + 1;
json.set_j(j);
let _ = json.update_string("batches[i].objects[j].type", "TAX");
let _ = json.update_string("batches[i].objects[j].id", "#SalesTax");
let _ = json.update_bool("batches[i].objects[j].present_at_all_locations", true);
let _ = json.update_string("batches[i].objects[j].tax_data.name", "Sales Tax");
let _ = json.update_string("batches[i].objects[j].tax_data.calculation_phase", "TAX_SUBTOTAL_PHASE");
let _ = json.update_string("batches[i].objects[j].tax_data.inclusion_type", "ADDITIVE");
let _ = json.update_string("batches[i].objects[j].tax_data.percentage", "5.0");
let _ = json.update_bool("batches[i].objects[j].tax_data.applies_to_custom_amounts", true);
let _ = json.update_bool("batches[i].objects[j].tax_data.enabled", true);

// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.set_auth_token("ACCESS_TOKEN");
http.set_request_header("Square-Version", "2020-07-22");

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
let resp = chilkat::HttpResponse::new();
if http.http_json("POST", "https://connect.squareupsandbox.com/v2/catalog/batch-upsert", &json, "application/json", &resp).is_err() {
    println!("{}", http.last_error_text());
    return;
}

let sb_response_body = chilkat::StringBuilder::new();
let _ = resp.get_body_sb(&sb_response_body);
let j_resp = chilkat::JsonObject::new();
let _ = j_resp.load_sb(&sb_response_body);
j_resp.set_emit_compact(false);

println!("Response Body:");
println!("{}", j_resp.emit().unwrap_or_default());

let resp_status_code = resp.status_code();
println!("Response Status Code = {}", resp_status_code);
if resp_status_code >= 400 {
    println!("Response Header:");
    println!("{}", resp.header());
    println!("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

let mut count_j: i32 = 0;

i = 0;
let mut count_i = j_resp.size_of_array("objects");
while i < count_i {
    j_resp.set_i(i);
    let _ = j_resp.string_of("objects[i].type").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].id").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].updated_at").unwrap_or_default();
    let _ = j_resp.int_of("objects[i].version");
    let _ = j_resp.bool_of("objects[i].is_deleted");
    let _ = j_resp.bool_of("objects[i].present_at_all_locations");
    let _ = j_resp.string_of("objects[i].item_data.name").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].item_data.description").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].item_data.category_id").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].category_data.name").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].tax_data.name").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].tax_data.calculation_phase").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].tax_data.inclusion_type").unwrap_or_default();
    let _ = j_resp.string_of("objects[i].tax_data.percentage").unwrap_or_default();
    let _ = j_resp.bool_of("objects[i].tax_data.applies_to_custom_amounts");
    let _ = j_resp.bool_of("objects[i].tax_data.enabled");
    j = 0;
    count_j = j_resp.size_of_array("objects[i].item_data.tax_ids");
    while j < count_j {
        j_resp.set_j(j);
        let _ = j_resp.string_of("objects[i].item_data.tax_ids[j]").unwrap_or_default();
        j = j + 1;
    }

    j = 0;
    count_j = j_resp.size_of_array("objects[i].item_data.variations");
    while j < count_j {
        j_resp.set_j(j);
        let _ = j_resp.string_of("objects[i].item_data.variations[j].type").unwrap_or_default();
        let _ = j_resp.string_of("objects[i].item_data.variations[j].id").unwrap_or_default();
        let _ = j_resp.string_of("objects[i].item_data.variations[j].updated_at").unwrap_or_default();
        let _ = j_resp.int_of("objects[i].item_data.variations[j].version");
        let _ = j_resp.bool_of("objects[i].item_data.variations[j].is_deleted");
        let _ = j_resp.bool_of("objects[i].item_data.variations[j].present_at_all_locations");
        let _ = j_resp.string_of("objects[i].item_data.variations[j].item_variation_data.item_id").unwrap_or_default();
        let _ = j_resp.string_of("objects[i].item_data.variations[j].item_variation_data.name").unwrap_or_default();
        let _ = j_resp.int_of("objects[i].item_data.variations[j].item_variation_data.ordinal");
        let _ = j_resp.string_of("objects[i].item_data.variations[j].item_variation_data.pricing_type").unwrap_or_default();
        let _ = j_resp.int_of("objects[i].item_data.variations[j].item_variation_data.price_money.amount");
        let _ = j_resp.string_of("objects[i].item_data.variations[j].item_variation_data.price_money.currency").unwrap_or_default();
        j = j + 1;
    }

    i = i + 1;
}

i = 0;
count_i = j_resp.size_of_array("id_mappings");
while i < count_i {
    j_resp.set_i(i);
    let _ = j_resp.string_of("id_mappings[i].client_object_id").unwrap_or_default();
    let _ = j_resp.string_of("id_mappings[i].object_id").unwrap_or_default();
    i = i + 1;
}