Sample code for 30+ languages & platforms
Rust

Square API - Batch Retrieve Catalog Objects

See more Square Examples

Returns a set of objects based on the provided ID.

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();

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

let json = chilkat::JsonObject::new();
let mut i = 0;
json.set_i(i);
let _ = json.update_string("object_ids[i]", "W62UWFY35CWMYGVWK6TWJDNI");
i = i + 1;
json.set_i(i);
let _ = json.update_string("object_ids[i]", "AA27W3M2GGTF3H6AVPNB77CK");
let _ = json.update_bool("include_related_objects", 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-retrieve", &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": "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

let mut j: i32 = 0;
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();
    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("related_objects");
while i < count_i {
    j_resp.set_i(i);
    let _ = j_resp.string_of("related_objects[i].type").unwrap_or_default();
    let _ = j_resp.string_of("related_objects[i].id").unwrap_or_default();
    let _ = j_resp.string_of("related_objects[i].updated_at").unwrap_or_default();
    let _ = j_resp.int_of("related_objects[i].version");
    let _ = j_resp.bool_of("related_objects[i].is_deleted");
    let _ = j_resp.bool_of("related_objects[i].present_at_all_locations");
    let _ = j_resp.string_of("related_objects[i].category_data.name").unwrap_or_default();
    let _ = j_resp.string_of("related_objects[i].tax_data.name").unwrap_or_default();
    let _ = j_resp.string_of("related_objects[i].tax_data.calculation_phase").unwrap_or_default();
    let _ = j_resp.string_of("related_objects[i].tax_data.inclusion_type").unwrap_or_default();
    let _ = j_resp.string_of("related_objects[i].tax_data.percentage").unwrap_or_default();
    let _ = j_resp.bool_of("related_objects[i].tax_data.enabled");
    i = i + 1;
}