Objective-C
Objective-C
Square API - Retrieve Catalog Object
See more Square Examples
Returns a single CatalogItem as a CatalogObject based on the provided ID.Chilkat Objective-C Downloads
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
BOOL success = NO;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
// 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.AuthToken = @"ACCESS_TOKEN";
[http SetRequestHeader: @"Square-Version" value: @"2020-07-22"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetUrlVar: @"id" value: @"2PTZYUOFGGDMT75UZLHQAPAC"];
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://connect.squareupsandbox.com/v2/catalog/object/{$id}?include_related_objects=true" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"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
NSString *strVal = 0;
NSString *v_type = 0;
NSString *id = 0;
NSString *updated_at = 0;
int version;
BOOL is_deleted;
BOOL present_at_all_locations;
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 *category_dataName = 0;
NSString *tax_dataName = 0;
NSString *tax_dataCalculation_phase = 0;
NSString *tax_dataInclusion_type = 0;
NSString *tax_dataPercentage = 0;
BOOL tax_dataEnabled;
NSString *objectType = [jResp StringOf: @"object.type"];
NSString *objectId = [jResp StringOf: @"object.id"];
NSString *objectUpdated_at = [jResp StringOf: @"object.updated_at"];
int objectVersion = [[jResp IntOf: @"object.version"] intValue];
BOOL objectIs_deleted = [jResp BoolOf: @"object.is_deleted"];
BOOL objectPresent_at_all_locations = [jResp BoolOf: @"object.present_at_all_locations"];
NSString *objectItem_dataName = [jResp StringOf: @"object.item_data.name"];
NSString *objectItem_dataDescription = [jResp StringOf: @"object.item_data.description"];
NSString *objectItem_dataCategory_id = [jResp StringOf: @"object.item_data.category_id"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"object.item_data.tax_ids"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
strVal = [jResp StringOf: @"object.item_data.tax_ids[i]"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"object.item_data.variations"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
v_type = [jResp StringOf: @"object.item_data.variations[i].type"];
id = [jResp StringOf: @"object.item_data.variations[i].id"];
updated_at = [jResp StringOf: @"object.item_data.variations[i].updated_at"];
version = [[jResp IntOf: @"object.item_data.variations[i].version"] intValue];
is_deleted = [jResp BoolOf: @"object.item_data.variations[i].is_deleted"];
present_at_all_locations = [jResp BoolOf: @"object.item_data.variations[i].present_at_all_locations"];
item_variation_dataItem_id = [jResp StringOf: @"object.item_data.variations[i].item_variation_data.item_id"];
item_variation_dataName = [jResp StringOf: @"object.item_data.variations[i].item_variation_data.name"];
item_variation_dataOrdinal = [[jResp IntOf: @"object.item_data.variations[i].item_variation_data.ordinal"] intValue];
item_variation_dataPricing_type = [jResp StringOf: @"object.item_data.variations[i].item_variation_data.pricing_type"];
item_variation_dataPrice_moneyAmount = [[jResp IntOf: @"object.item_data.variations[i].item_variation_data.price_money.amount"] intValue];
item_variation_dataPrice_moneyCurrency = [jResp StringOf: @"object.item_data.variations[i].item_variation_data.price_money.currency"];
i = i + 1;
}
i = 0;
count_i = [[jResp SizeOfArray: @"related_objects"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
v_type = [jResp StringOf: @"related_objects[i].type"];
id = [jResp StringOf: @"related_objects[i].id"];
updated_at = [jResp StringOf: @"related_objects[i].updated_at"];
version = [[jResp IntOf: @"related_objects[i].version"] intValue];
is_deleted = [jResp BoolOf: @"related_objects[i].is_deleted"];
present_at_all_locations = [jResp BoolOf: @"related_objects[i].present_at_all_locations"];
category_dataName = [jResp StringOf: @"related_objects[i].category_data.name"];
tax_dataName = [jResp StringOf: @"related_objects[i].tax_data.name"];
tax_dataCalculation_phase = [jResp StringOf: @"related_objects[i].tax_data.calculation_phase"];
tax_dataInclusion_type = [jResp StringOf: @"related_objects[i].tax_data.inclusion_type"];
tax_dataPercentage = [jResp StringOf: @"related_objects[i].tax_data.percentage"];
tax_dataEnabled = [jResp BoolOf: @"related_objects[i].tax_data.enabled"];
i = i + 1;
}