Lianja
Lianja
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat Lianja Downloads
llSuccess = .F.
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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
// }
loJson = createobject("CkJsonObject")
i = 0
loJson.I = i
loJson.UpdateString("object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
loJson.I = i
loJson.UpdateString("object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")
loJson.UpdateBool("include_related_objects",.T.)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
loHttp.AuthToken = "ACCESS_TOKEN"
loHttp.SetRequestHeader("Square-Version","2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/batch-retrieve",loJson,"application/json",loResp)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loResp
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loHttp
release loJson
release loResp
release loSbResponseBody
release loJResp
return
endif
// 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
lnCount_i = loJResp.SizeOfArray("objects")
do while i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("objects[i].type")
lcId = loJResp.StringOf("objects[i].id")
lcUpdated_at = loJResp.StringOf("objects[i].updated_at")
lnVersion = loJResp.IntOf("objects[i].version")
llIs_deleted = loJResp.BoolOf("objects[i].is_deleted")
llPresent_at_all_locations = loJResp.BoolOf("objects[i].present_at_all_locations")
lcItem_dataName = loJResp.StringOf("objects[i].item_data.name")
lcItem_dataDescription = loJResp.StringOf("objects[i].item_data.description")
lcItem_dataCategory_id = loJResp.StringOf("objects[i].item_data.category_id")
j = 0
lnCount_j = loJResp.SizeOfArray("objects[i].item_data.tax_ids")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("objects[i].item_data.tax_ids[j]")
j = j + 1
enddo
j = 0
lnCount_j = loJResp.SizeOfArray("objects[i].item_data.variations")
do while j < lnCount_j
loJResp.J = j
lcV_type = loJResp.StringOf("objects[i].item_data.variations[j].type")
lcId = loJResp.StringOf("objects[i].item_data.variations[j].id")
lcUpdated_at = loJResp.StringOf("objects[i].item_data.variations[j].updated_at")
lnVersion = loJResp.IntOf("objects[i].item_data.variations[j].version")
llIs_deleted = loJResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
llPresent_at_all_locations = loJResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
lcItem_variation_dataItem_id = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
lcItem_variation_dataName = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
lnItem_variation_dataOrdinal = loJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
lcItem_variation_dataPricing_type = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
lnItem_variation_dataPrice_moneyAmount = loJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
lcItem_variation_dataPrice_moneyCurrency = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
j = j + 1
enddo
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("related_objects")
do while i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("related_objects[i].type")
lcId = loJResp.StringOf("related_objects[i].id")
lcUpdated_at = loJResp.StringOf("related_objects[i].updated_at")
lnVersion = loJResp.IntOf("related_objects[i].version")
llIs_deleted = loJResp.BoolOf("related_objects[i].is_deleted")
llPresent_at_all_locations = loJResp.BoolOf("related_objects[i].present_at_all_locations")
lcCategory_dataName = loJResp.StringOf("related_objects[i].category_data.name")
lcTax_dataName = loJResp.StringOf("related_objects[i].tax_data.name")
lcTax_dataCalculation_phase = loJResp.StringOf("related_objects[i].tax_data.calculation_phase")
lcTax_dataInclusion_type = loJResp.StringOf("related_objects[i].tax_data.inclusion_type")
lcTax_dataPercentage = loJResp.StringOf("related_objects[i].tax_data.percentage")
llTax_dataEnabled = loJResp.BoolOf("related_objects[i].tax_data.enabled")
i = i + 1
enddo
release loHttp
release loJson
release loResp
release loSbResponseBody
release loJResp