AutoIt
AutoIt
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.Chilkat AutoIt Downloads
Local $bSuccess = False
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("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 = ObjCreate("Chilkat.JsonObject")
Local $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",True)
; 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 = ObjCreate("Chilkat.HttpResponse")
$bSuccess = $oHttp.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/batch-retrieve",$oJson,"application/json",$oResp)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
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
Local $sV_type
Local $sId
Local $sUpdated_at
Local $iVersion
Local $bIs_deleted
Local $bPresent_at_all_locations
Local $sItem_dataName
Local $sItem_dataDescription
Local $sItem_dataCategory_id
Local $iJ
Local $iCount_j
Local $strVal
Local $sItem_variation_dataItem_id
Local $sItem_variation_dataName
Local $item_variation_dataOrdinal
Local $sItem_variation_dataPricing_type
Local $item_variation_dataPrice_moneyAmount
Local $sItem_variation_dataPrice_moneyCurrency
Local $sCategory_dataName
Local $sTax_dataName
Local $sTax_dataCalculation_phase
Local $sTax_dataInclusion_type
Local $sTax_dataPercentage
Local $bTax_dataEnabled
$i = 0
Local $iCount_i = $oJResp.SizeOfArray("objects")
While $i < $iCount_i
$oJResp.I = $i
$sV_type = $oJResp.StringOf("objects[i].type")
$sId = $oJResp.StringOf("objects[i].id")
$sUpdated_at = $oJResp.StringOf("objects[i].updated_at")
$iVersion = $oJResp.IntOf("objects[i].version")
$bIs_deleted = $oJResp.BoolOf("objects[i].is_deleted")
$bPresent_at_all_locations = $oJResp.BoolOf("objects[i].present_at_all_locations")
$sItem_dataName = $oJResp.StringOf("objects[i].item_data.name")
$sItem_dataDescription = $oJResp.StringOf("objects[i].item_data.description")
$sItem_dataCategory_id = $oJResp.StringOf("objects[i].item_data.category_id")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("objects[i].item_data.tax_ids")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("objects[i].item_data.tax_ids[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("objects[i].item_data.variations")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sV_type = $oJResp.StringOf("objects[i].item_data.variations[j].type")
$sId = $oJResp.StringOf("objects[i].item_data.variations[j].id")
$sUpdated_at = $oJResp.StringOf("objects[i].item_data.variations[j].updated_at")
$iVersion = $oJResp.IntOf("objects[i].item_data.variations[j].version")
$bIs_deleted = $oJResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
$bPresent_at_all_locations = $oJResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
$sItem_variation_dataItem_id = $oJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
$sItem_variation_dataName = $oJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
$item_variation_dataOrdinal = $oJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
$sItem_variation_dataPricing_type = $oJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
$item_variation_dataPrice_moneyAmount = $oJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
$sItem_variation_dataPrice_moneyCurrency = $oJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("related_objects")
While $i < $iCount_i
$oJResp.I = $i
$sV_type = $oJResp.StringOf("related_objects[i].type")
$sId = $oJResp.StringOf("related_objects[i].id")
$sUpdated_at = $oJResp.StringOf("related_objects[i].updated_at")
$iVersion = $oJResp.IntOf("related_objects[i].version")
$bIs_deleted = $oJResp.BoolOf("related_objects[i].is_deleted")
$bPresent_at_all_locations = $oJResp.BoolOf("related_objects[i].present_at_all_locations")
$sCategory_dataName = $oJResp.StringOf("related_objects[i].category_data.name")
$sTax_dataName = $oJResp.StringOf("related_objects[i].tax_data.name")
$sTax_dataCalculation_phase = $oJResp.StringOf("related_objects[i].tax_data.calculation_phase")
$sTax_dataInclusion_type = $oJResp.StringOf("related_objects[i].tax_data.inclusion_type")
$sTax_dataPercentage = $oJResp.StringOf("related_objects[i].tax_data.percentage")
$bTax_dataEnabled = $oJResp.BoolOf("related_objects[i].tax_data.enabled")
$i = $i + 1
Wend