Rust

Square API - Retrieve Catalog Object

See more Square Examples

Returns a single CatalogItem as a CatalogObject based on the provided ID. 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/object/W62UWFY35CWMYGVWK6TWJDNI?include_related_objects=true \
//   -H 'Square-Version: 2020-07-22' \
//   -H 'Authorization: Bearer ACCESS_TOKEN' \
//   -H 'Content-Type: application/json'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

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

let _ = http.set_url_var("id", "2PTZYUOFGGDMT75UZLHQAPAC");

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
let sb_response_body = chilkat::StringBuilder::new();
if http.quick_get_sb("https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true", &sb_response_body).is_err() {
    println!("{}", http.last_error_text());
    return;
}

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 = http.last_status();
println!("Response Status Code = {}", resp_status_code);
if resp_status_code >= 400 {
    println!("Response Header:");
    println!("{}", http.last_header());
    println!("Failed.");
    return;
}

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

// {
//   "object": {
//     "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"
//             }
//           }
//         }
//       ]
//     }
//   },
//   "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 object_type = j_resp.string_of("object.type").unwrap_or_default();
let object_id = j_resp.string_of("object.id").unwrap_or_default();
let object_updated_at = j_resp.string_of("object.updated_at").unwrap_or_default();
let object_version = j_resp.int_of("object.version");
let object_is_deleted = j_resp.bool_of("object.is_deleted");
let object_present_at_all_locations = j_resp.bool_of("object.present_at_all_locations");
let object_item_data_name = j_resp.string_of("object.item_data.name").unwrap_or_default();
let object_item_data_description = j_resp.string_of("object.item_data.description").unwrap_or_default();
let object_item_data_category_id = j_resp.string_of("object.item_data.category_id").unwrap_or_default();
let mut i = 0;
let mut count_i = j_resp.size_of_array("object.item_data.tax_ids");
while i < count_i {
    j_resp.set_i(i);
    let _ = j_resp.string_of("object.item_data.tax_ids[i]").unwrap_or_default();
    i = i + 1;
}

i = 0;
count_i = j_resp.size_of_array("object.item_data.variations");
while i < count_i {
    j_resp.set_i(i);
    let _ = j_resp.string_of("object.item_data.variations[i].type").unwrap_or_default();
    let _ = j_resp.string_of("object.item_data.variations[i].id").unwrap_or_default();
    let _ = j_resp.string_of("object.item_data.variations[i].updated_at").unwrap_or_default();
    let _ = j_resp.int_of("object.item_data.variations[i].version");
    let _ = j_resp.bool_of("object.item_data.variations[i].is_deleted");
    let _ = j_resp.bool_of("object.item_data.variations[i].present_at_all_locations");
    let _ = j_resp.string_of("object.item_data.variations[i].item_variation_data.item_id").unwrap_or_default();
    let _ = j_resp.string_of("object.item_data.variations[i].item_variation_data.name").unwrap_or_default();
    let _ = j_resp.int_of("object.item_data.variations[i].item_variation_data.ordinal");
    let _ = j_resp.string_of("object.item_data.variations[i].item_variation_data.pricing_type").unwrap_or_default();
    let _ = j_resp.int_of("object.item_data.variations[i].item_variation_data.price_money.amount");
    let _ = j_resp.string_of("object.item_data.variations[i].item_variation_data.price_money.currency").unwrap_or_default();
    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;
}