Dart
Dart
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
final http = CkHttp();
// 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
// }
final json = CkJsonObject();
var i = 0;
json.i = i;
json.updateString('object_ids[i]', 'W62UWFY35CWMYGVWK6TWJDNI');
i++;
json.i = i;
json.updateString('object_ids[i]', 'AA27W3M2GGTF3H6AVPNB77CK');
json.updateBool('include_related_objects', true);
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.authToken = 'ACCESS_TOKEN';
http.setRequestHeader('Square-Version', '2020-07-22');
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
final resp = CkHttpResponse();
try {
http.httpJson('POST', 'https://connect.squareupsandbox.com/v2/catalog/batch-retrieve', json, 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
final sbResponseBody = CkStringBuilder();
resp.getBodySb(sbResponseBody);
final jResp = CkJsonObject();
jResp.loadSb(sbResponseBody);
jResp.emitCompact = false;
print('Response Body:');
print(jResp.emit());
final respStatusCode = resp.statusCode;
print('Response Status Code = $respStatusCode');
if (respStatusCode >= 400) {
print('Response Header:');
print(resp.header);
print('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
var vType = '';
var id = '';
var updatedAt = '';
var version = 0;
var itemDataName = '';
var itemDataDescription = '';
var itemDataCategoryId = '';
var j = 0;
var countJ = 0;
var strVal = '';
var itemVariationDataItemId = '';
var itemVariationDataName = '';
var itemVariationDataOrdinal = 0;
var itemVariationDataPricingType = '';
var itemVariationDataPriceMoneyAmount = 0;
var itemVariationDataPriceMoneyCurrency = '';
var categoryDataName = '';
var taxDataName = '';
var taxDataCalculationPhase = '';
var taxDataInclusionType = '';
var taxDataPercentage = '';
i = 0;
var countI = jResp.sizeOfArray('objects');
while (i < countI) {
jResp.i = i;
vType = jResp.stringOf('objects[i].type');
id = jResp.stringOf('objects[i].id');
updatedAt = jResp.stringOf('objects[i].updated_at');
version = jResp.intOf('objects[i].version');
jResp.boolOf('objects[i].is_deleted');
jResp.boolOf('objects[i].present_at_all_locations');
itemDataName = jResp.stringOf('objects[i].item_data.name');
itemDataDescription = jResp.stringOf('objects[i].item_data.description');
itemDataCategoryId = jResp.stringOf('objects[i].item_data.category_id');
j = 0;
countJ = jResp.sizeOfArray('objects[i].item_data.tax_ids');
while (j < countJ) {
jResp.j = j;
strVal = jResp.stringOf('objects[i].item_data.tax_ids[j]');
j++;
}
j = 0;
countJ = jResp.sizeOfArray('objects[i].item_data.variations');
while (j < countJ) {
jResp.j = j;
vType = jResp.stringOf('objects[i].item_data.variations[j].type');
id = jResp.stringOf('objects[i].item_data.variations[j].id');
updatedAt = jResp.stringOf('objects[i].item_data.variations[j].updated_at');
version = jResp.intOf('objects[i].item_data.variations[j].version');
jResp.boolOf('objects[i].item_data.variations[j].is_deleted');
jResp.boolOf('objects[i].item_data.variations[j].present_at_all_locations');
itemVariationDataItemId = jResp.stringOf('objects[i].item_data.variations[j].item_variation_data.item_id');
itemVariationDataName = jResp.stringOf('objects[i].item_data.variations[j].item_variation_data.name');
itemVariationDataOrdinal = jResp.intOf('objects[i].item_data.variations[j].item_variation_data.ordinal');
itemVariationDataPricingType = jResp.stringOf('objects[i].item_data.variations[j].item_variation_data.pricing_type');
itemVariationDataPriceMoneyAmount = jResp.intOf('objects[i].item_data.variations[j].item_variation_data.price_money.amount');
itemVariationDataPriceMoneyCurrency = jResp.stringOf('objects[i].item_data.variations[j].item_variation_data.price_money.currency');
j++;
}
i++;
}
i = 0;
countI = jResp.sizeOfArray('related_objects');
while (i < countI) {
jResp.i = i;
vType = jResp.stringOf('related_objects[i].type');
id = jResp.stringOf('related_objects[i].id');
updatedAt = jResp.stringOf('related_objects[i].updated_at');
version = jResp.intOf('related_objects[i].version');
jResp.boolOf('related_objects[i].is_deleted');
jResp.boolOf('related_objects[i].present_at_all_locations');
categoryDataName = jResp.stringOf('related_objects[i].category_data.name');
taxDataName = jResp.stringOf('related_objects[i].tax_data.name');
taxDataCalculationPhase = jResp.stringOf('related_objects[i].tax_data.calculation_phase');
taxDataInclusionType = jResp.stringOf('related_objects[i].tax_data.inclusion_type');
taxDataPercentage = jResp.stringOf('related_objects[i].tax_data.percentage');
jResp.boolOf('related_objects[i].tax_data.enabled');
i++;
}
}