Java
Chilkat2 Java
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Http http = new Http();
// 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
// }
JsonObject json = new JsonObject();
int i = 0;
json.setI(i);
json.updateString("object_ids[i]", "W62UWFY35CWMYGVWK6TWJDNI");
i = i + 1;
json.setI(i);
json.updateString("object_ids[i]", "AA27W3M2GGTF3H6AVPNB77CK");
json.updateBool("include_related_objects", true);
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.setAuthToken("ACCESS_TOKEN");
http.setRequestHeader("Square-Version", "2020-07-22");
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
HttpResponse resp = new HttpResponse();
try {
http.httpJson("POST", "https://connect.squareupsandbox.com/v2/catalog/batch-retrieve", json, "application/json", resp);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
StringBuilder sbResponseBody = new StringBuilder();
resp.getBodySb(sbResponseBody);
JsonObject jResp = new JsonObject();
jResp.loadSb(sbResponseBody);
jResp.setEmitCompact(false);
System.out.println("Response Body:");
System.out.println(jResp.emit());
int respStatusCode = resp.getStatusCode();
System.out.println("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
System.out.println("Response Header:");
System.out.println(resp.getHeader());
System.out.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
String v_type = "";
String id = "";
String updated_at = "";
int version = 0;
boolean is_deleted = false;
boolean present_at_all_locations = false;
String item_dataName = "";
String item_dataDescription = "";
String item_dataCategory_id = "";
int j = 0;
int count_j = 0;
String strVal = "";
String item_variation_dataItem_id = "";
String item_variation_dataName = "";
int item_variation_dataOrdinal = 0;
String item_variation_dataPricing_type = "";
int item_variation_dataPrice_moneyAmount = 0;
String item_variation_dataPrice_moneyCurrency = "";
String category_dataName = "";
String tax_dataName = "";
String tax_dataCalculation_phase = "";
String tax_dataInclusion_type = "";
String tax_dataPercentage = "";
boolean tax_dataEnabled = false;
i = 0;
int count_i = jResp.sizeOfArray("objects");
while (i < count_i) {
jResp.setI(i);
v_type = jResp.stringOf("objects[i].type");
id = jResp.stringOf("objects[i].id");
updated_at = jResp.stringOf("objects[i].updated_at");
version = jResp.intOf("objects[i].version");
is_deleted = jResp.boolOf("objects[i].is_deleted");
present_at_all_locations = jResp.boolOf("objects[i].present_at_all_locations");
item_dataName = jResp.stringOf("objects[i].item_data.name");
item_dataDescription = jResp.stringOf("objects[i].item_data.description");
item_dataCategory_id = jResp.stringOf("objects[i].item_data.category_id");
j = 0;
count_j = jResp.sizeOfArray("objects[i].item_data.tax_ids");
while (j < count_j) {
jResp.setJ(j);
strVal = jResp.stringOf("objects[i].item_data.tax_ids[j]");
j = j + 1;
}
j = 0;
count_j = jResp.sizeOfArray("objects[i].item_data.variations");
while (j < count_j) {
jResp.setJ(j);
v_type = jResp.stringOf("objects[i].item_data.variations[j].type");
id = jResp.stringOf("objects[i].item_data.variations[j].id");
updated_at = jResp.stringOf("objects[i].item_data.variations[j].updated_at");
version = jResp.intOf("objects[i].item_data.variations[j].version");
is_deleted = jResp.boolOf("objects[i].item_data.variations[j].is_deleted");
present_at_all_locations = jResp.boolOf("objects[i].item_data.variations[j].present_at_all_locations");
item_variation_dataItem_id = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.item_id");
item_variation_dataName = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.name");
item_variation_dataOrdinal = jResp.intOf("objects[i].item_data.variations[j].item_variation_data.ordinal");
item_variation_dataPricing_type = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type");
item_variation_dataPrice_moneyAmount = jResp.intOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount");
item_variation_dataPrice_moneyCurrency = jResp.stringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency");
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = jResp.sizeOfArray("related_objects");
while (i < count_i) {
jResp.setI(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");
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;
}
}
}