PowerBuilder
PowerBuilder
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat PowerBuilder Downloads
integer li_rc
long li_Success
oleobject loo_Http
oleobject loo_Json
long i
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
long li_RespStatusCode
string ls_V_type
string ls_Id
string ls_Updated_at
long li_Version
long li_Is_deleted
long li_Present_at_all_locations
string ls_Item_dataName
string ls_Item_dataDescription
string ls_Item_dataCategory_id
long j
long li_Count_j
string ls_StrVal
string ls_Item_variation_dataItem_id
string ls_Item_variation_dataName
long li_Item_variation_dataOrdinal
string ls_Item_variation_dataPricing_type
long li_Item_variation_dataPrice_moneyAmount
string ls_Item_variation_dataPrice_moneyCurrency
string ls_Category_dataName
string ls_Tax_dataName
string ls_Tax_dataCalculation_phase
string ls_Tax_dataInclusion_type
string ls_Tax_dataPercentage
long li_Tax_dataEnabled
long li_Count_i
li_Success = 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
i = 0
loo_Json.I = i
loo_Json.UpdateString("object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
loo_Json.I = i
loo_Json.UpdateString("object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")
loo_Json.UpdateBool("include_related_objects",1)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
loo_Http.AuthToken = "ACCESS_TOKEN"
loo_Http.SetRequestHeader("Square-Version","2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")
li_Success = loo_Http.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/batch-retrieve",loo_Json,"application/json",loo_Resp)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_Resp
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Http
destroy loo_Json
destroy loo_Resp
destroy loo_SbResponseBody
destroy loo_JResp
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
i = 0
li_Count_i = loo_JResp.SizeOfArray("objects")
do while i < li_Count_i
loo_JResp.I = i
ls_V_type = loo_JResp.StringOf("objects[i].type")
ls_Id = loo_JResp.StringOf("objects[i].id")
ls_Updated_at = loo_JResp.StringOf("objects[i].updated_at")
li_Version = loo_JResp.IntOf("objects[i].version")
li_Is_deleted = loo_JResp.BoolOf("objects[i].is_deleted")
li_Present_at_all_locations = loo_JResp.BoolOf("objects[i].present_at_all_locations")
ls_Item_dataName = loo_JResp.StringOf("objects[i].item_data.name")
ls_Item_dataDescription = loo_JResp.StringOf("objects[i].item_data.description")
ls_Item_dataCategory_id = loo_JResp.StringOf("objects[i].item_data.category_id")
j = 0
li_Count_j = loo_JResp.SizeOfArray("objects[i].item_data.tax_ids")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("objects[i].item_data.tax_ids[j]")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("objects[i].item_data.variations")
do while j < li_Count_j
loo_JResp.J = j
ls_V_type = loo_JResp.StringOf("objects[i].item_data.variations[j].type")
ls_Id = loo_JResp.StringOf("objects[i].item_data.variations[j].id")
ls_Updated_at = loo_JResp.StringOf("objects[i].item_data.variations[j].updated_at")
li_Version = loo_JResp.IntOf("objects[i].item_data.variations[j].version")
li_Is_deleted = loo_JResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
li_Present_at_all_locations = loo_JResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
ls_Item_variation_dataItem_id = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
ls_Item_variation_dataName = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
li_Item_variation_dataOrdinal = loo_JResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
ls_Item_variation_dataPricing_type = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
li_Item_variation_dataPrice_moneyAmount = loo_JResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
ls_Item_variation_dataPrice_moneyCurrency = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
j = j + 1
loop
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("related_objects")
do while i < li_Count_i
loo_JResp.I = i
ls_V_type = loo_JResp.StringOf("related_objects[i].type")
ls_Id = loo_JResp.StringOf("related_objects[i].id")
ls_Updated_at = loo_JResp.StringOf("related_objects[i].updated_at")
li_Version = loo_JResp.IntOf("related_objects[i].version")
li_Is_deleted = loo_JResp.BoolOf("related_objects[i].is_deleted")
li_Present_at_all_locations = loo_JResp.BoolOf("related_objects[i].present_at_all_locations")
ls_Category_dataName = loo_JResp.StringOf("related_objects[i].category_data.name")
ls_Tax_dataName = loo_JResp.StringOf("related_objects[i].tax_data.name")
ls_Tax_dataCalculation_phase = loo_JResp.StringOf("related_objects[i].tax_data.calculation_phase")
ls_Tax_dataInclusion_type = loo_JResp.StringOf("related_objects[i].tax_data.inclusion_type")
ls_Tax_dataPercentage = loo_JResp.StringOf("related_objects[i].tax_data.percentage")
li_Tax_dataEnabled = loo_JResp.BoolOf("related_objects[i].tax_data.enabled")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_Resp
destroy loo_SbResponseBody
destroy loo_JResp