Xojo Plugin
Xojo Plugin
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.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
// }
Dim json As New Chilkat.JsonObject
Dim i As Int32
i = 0
json.I = i
success = json.UpdateString("object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
json.I = i
success = json.UpdateString("object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")
success = 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
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/batch-retrieve",json,"application/json",resp)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim v_type As String
Dim id As String
Dim updated_at As String
Dim version As Int32
Dim is_deleted As Boolean
Dim present_at_all_locations As Boolean
Dim item_dataName As String
Dim item_dataDescription As String
Dim item_dataCategory_id As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim item_variation_dataItem_id As String
Dim item_variation_dataName As String
Dim item_variation_dataOrdinal As Int32
Dim item_variation_dataPricing_type As String
Dim item_variation_dataPrice_moneyAmount As Int32
Dim item_variation_dataPrice_moneyCurrency As String
Dim category_dataName As String
Dim tax_dataName As String
Dim tax_dataCalculation_phase As String
Dim tax_dataInclusion_type As String
Dim tax_dataPercentage As String
Dim tax_dataEnabled As Boolean
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("objects")
While i < count_i
jResp.I = 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.J = j
strVal = jResp.StringOf("objects[i].item_data.tax_ids[j]")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("objects[i].item_data.variations")
While j < count_j
jResp.J = 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
Wend
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("related_objects")
While i < count_i
jResp.I = 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
Wend