Xbase++
Xbase++
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oJson
LOCAL i
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cV_type
LOCAL cId
LOCAL cUpdated_at
LOCAL nVersion
LOCAL nIs_deleted
LOCAL nPresent_at_all_locations
LOCAL cItem_dataName
LOCAL cItem_dataDescription
LOCAL cItem_dataCategory_id
LOCAL j
LOCAL nCount_j
LOCAL cStrVal
LOCAL cItem_variation_dataItem_id
LOCAL cItem_variation_dataName
LOCAL nItem_variation_dataOrdinal
LOCAL cItem_variation_dataPricing_type
LOCAL nItem_variation_dataPrice_moneyAmount
LOCAL cItem_variation_dataPrice_moneyCurrency
LOCAL cCategory_dataName
LOCAL cTax_dataName
LOCAL cTax_dataCalculation_phase
LOCAL cTax_dataInclusion_type
LOCAL cTax_dataPercentage
LOCAL nTax_dataEnabled
LOCAL nCount_i
nSuccess := 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oHttp := CreateObject("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
// }
oJson := CreateObject("Chilkat.JsonObject")
i := 0
oJson:I := i
oJson:UpdateString("object_ids[i]", "W62UWFY35CWMYGVWK6TWJDNI")
i := i + 1
oJson:I := i
oJson:UpdateString("object_ids[i]", "AA27W3M2GGTF3H6AVPNB77CK")
oJson:UpdateBool("include_related_objects", 1)
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
oHttp:AuthToken := "ACCESS_TOKEN"
oHttp:SetRequestHeader("Square-Version", "2020-07-22")
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", "https://connect.squareupsandbox.com/v2/catalog/batch-retrieve", oJson, "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJson:destroy()
oResp:destroy()
RETURN
ENDIF
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0
? "Response Body:"
? oJResp:Emit()
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
? "Response Header:"
? oResp:Header
? "Failed."
oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()
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
nCount_i := oJResp:SizeOfArray("objects")
DO WHILE i < nCount_i
oJResp:I := i
cV_type := oJResp:StringOf("objects[i].type")
cId := oJResp:StringOf("objects[i].id")
cUpdated_at := oJResp:StringOf("objects[i].updated_at")
nVersion := oJResp:IntOf("objects[i].version")
nIs_deleted := oJResp:BoolOf("objects[i].is_deleted")
nPresent_at_all_locations := oJResp:BoolOf("objects[i].present_at_all_locations")
cItem_dataName := oJResp:StringOf("objects[i].item_data.name")
cItem_dataDescription := oJResp:StringOf("objects[i].item_data.description")
cItem_dataCategory_id := oJResp:StringOf("objects[i].item_data.category_id")
j := 0
nCount_j := oJResp:SizeOfArray("objects[i].item_data.tax_ids")
DO WHILE j < nCount_j
oJResp:J := j
cStrVal := oJResp:StringOf("objects[i].item_data.tax_ids[j]")
j := j + 1
ENDDO
j := 0
nCount_j := oJResp:SizeOfArray("objects[i].item_data.variations")
DO WHILE j < nCount_j
oJResp:J := j
cV_type := oJResp:StringOf("objects[i].item_data.variations[j].type")
cId := oJResp:StringOf("objects[i].item_data.variations[j].id")
cUpdated_at := oJResp:StringOf("objects[i].item_data.variations[j].updated_at")
nVersion := oJResp:IntOf("objects[i].item_data.variations[j].version")
nIs_deleted := oJResp:BoolOf("objects[i].item_data.variations[j].is_deleted")
nPresent_at_all_locations := oJResp:BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
cItem_variation_dataItem_id := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
cItem_variation_dataName := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.name")
nItem_variation_dataOrdinal := oJResp:IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
cItem_variation_dataPricing_type := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
nItem_variation_dataPrice_moneyAmount := oJResp:IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
cItem_variation_dataPrice_moneyCurrency := oJResp:StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
j := j + 1
ENDDO
i := i + 1
ENDDO
i := 0
nCount_i := oJResp:SizeOfArray("related_objects")
DO WHILE i < nCount_i
oJResp:I := i
cV_type := oJResp:StringOf("related_objects[i].type")
cId := oJResp:StringOf("related_objects[i].id")
cUpdated_at := oJResp:StringOf("related_objects[i].updated_at")
nVersion := oJResp:IntOf("related_objects[i].version")
nIs_deleted := oJResp:BoolOf("related_objects[i].is_deleted")
nPresent_at_all_locations := oJResp:BoolOf("related_objects[i].present_at_all_locations")
cCategory_dataName := oJResp:StringOf("related_objects[i].category_data.name")
cTax_dataName := oJResp:StringOf("related_objects[i].tax_data.name")
cTax_dataCalculation_phase := oJResp:StringOf("related_objects[i].tax_data.calculation_phase")
cTax_dataInclusion_type := oJResp:StringOf("related_objects[i].tax_data.inclusion_type")
cTax_dataPercentage := oJResp:StringOf("related_objects[i].tax_data.percentage")
nTax_dataEnabled := oJResp:BoolOf("related_objects[i].tax_data.enabled")
i := i + 1
ENDDO
oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()