DataFlex
DataFlex
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Variant vJson
Handle hoJson
Integer i
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sV_type
String sId
String sUpdated_at
Integer iVersion
Boolean iIs_deleted
Boolean iPresent_at_all_locations
String sItem_dataName
String sItem_dataDescription
String sItem_dataCategory_id
Integer j
Integer iCount_j
String sStrVal
String sItem_variation_dataItem_id
String sItem_variation_dataName
Integer iItem_variation_dataOrdinal
String sItem_variation_dataPricing_type
Integer iItem_variation_dataPrice_moneyAmount
String sItem_variation_dataPrice_moneyCurrency
String sCategory_dataName
String sTax_dataName
String sTax_dataCalculation_phase
String sTax_dataInclusion_type
String sTax_dataPercentage
Boolean iTax_dataEnabled
Integer iCount_i
String sTemp1
Move False To iSuccess
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Move 0 To i
Set ComI Of hoJson To i
Get ComUpdateString Of hoJson "object_ids[i]" "W62UWFY35CWMYGVWK6TWJDNI" To iSuccess
Move (i + 1) To i
Set ComI Of hoJson To i
Get ComUpdateString Of hoJson "object_ids[i]" "AA27W3M2GGTF3H6AVPNB77CK" To iSuccess
Get ComUpdateBool Of hoJson "include_related_objects" True To iSuccess
// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
Set ComAuthToken Of hoHttp To "ACCESS_TOKEN"
Send ComSetRequestHeader To hoHttp "Square-Version" "2020-07-22"
// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoJson to vJson
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "https://connect.squareupsandbox.com/v2/catalog/batch-retrieve" vJson "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "objects" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "objects[i].type" To sV_type
Get ComStringOf Of hoJResp "objects[i].id" To sId
Get ComStringOf Of hoJResp "objects[i].updated_at" To sUpdated_at
Get ComIntOf Of hoJResp "objects[i].version" To iVersion
Get ComBoolOf Of hoJResp "objects[i].is_deleted" To iIs_deleted
Get ComBoolOf Of hoJResp "objects[i].present_at_all_locations" To iPresent_at_all_locations
Get ComStringOf Of hoJResp "objects[i].item_data.name" To sItem_dataName
Get ComStringOf Of hoJResp "objects[i].item_data.description" To sItem_dataDescription
Get ComStringOf Of hoJResp "objects[i].item_data.category_id" To sItem_dataCategory_id
Move 0 To j
Get ComSizeOfArray Of hoJResp "objects[i].item_data.tax_ids" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "objects[i].item_data.tax_ids[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "objects[i].item_data.variations" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].type" To sV_type
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].id" To sId
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].updated_at" To sUpdated_at
Get ComIntOf Of hoJResp "objects[i].item_data.variations[j].version" To iVersion
Get ComBoolOf Of hoJResp "objects[i].item_data.variations[j].is_deleted" To iIs_deleted
Get ComBoolOf Of hoJResp "objects[i].item_data.variations[j].present_at_all_locations" To iPresent_at_all_locations
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].item_variation_data.item_id" To sItem_variation_dataItem_id
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].item_variation_data.name" To sItem_variation_dataName
Get ComIntOf Of hoJResp "objects[i].item_data.variations[j].item_variation_data.ordinal" To iItem_variation_dataOrdinal
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].item_variation_data.pricing_type" To sItem_variation_dataPricing_type
Get ComIntOf Of hoJResp "objects[i].item_data.variations[j].item_variation_data.price_money.amount" To iItem_variation_dataPrice_moneyAmount
Get ComStringOf Of hoJResp "objects[i].item_data.variations[j].item_variation_data.price_money.currency" To sItem_variation_dataPrice_moneyCurrency
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "related_objects" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "related_objects[i].type" To sV_type
Get ComStringOf Of hoJResp "related_objects[i].id" To sId
Get ComStringOf Of hoJResp "related_objects[i].updated_at" To sUpdated_at
Get ComIntOf Of hoJResp "related_objects[i].version" To iVersion
Get ComBoolOf Of hoJResp "related_objects[i].is_deleted" To iIs_deleted
Get ComBoolOf Of hoJResp "related_objects[i].present_at_all_locations" To iPresent_at_all_locations
Get ComStringOf Of hoJResp "related_objects[i].category_data.name" To sCategory_dataName
Get ComStringOf Of hoJResp "related_objects[i].tax_data.name" To sTax_dataName
Get ComStringOf Of hoJResp "related_objects[i].tax_data.calculation_phase" To sTax_dataCalculation_phase
Get ComStringOf Of hoJResp "related_objects[i].tax_data.inclusion_type" To sTax_dataInclusion_type
Get ComStringOf Of hoJResp "related_objects[i].tax_data.percentage" To sTax_dataPercentage
Get ComBoolOf Of hoJResp "related_objects[i].tax_data.enabled" To iTax_dataEnabled
Move (i + 1) To i
Loop
End_Procedure