AutoIt

Square API - List Catalog

See more Square Examples

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog. AutoIt

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/list?types=category%2Ctax \
;    -H 'Square-Version: 2020-07-22' \
;    -H 'Authorization: Bearer ACCESS_TOKEN' \
;    -H 'Content-Type: application/json'

;  Use the following online tool to generate HTTP code from a CURL command
;  Convert a cURL Command to HTTP Source Code

;  Adds the "Authorization: Bearer ACCESS_TOKEN" header.
$oHttp.AuthToken = "ACCESS_TOKEN"
$oHttp.SetRequestHeader "Square-Version","2020-07-22"
$oHttp.SetRequestHeader "Content-Type","application/json"

;  This example uses the sandbox: connect.squareupsandbox.com
;  Production should use connect.squareup.com
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

;  Sample JSON response:
;  (Sample code for parsing the JSON response is shown below)

;  {
;    "objects": [
;      {
;        "type": "CATEGORY",
;        "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
;        "updated_at": "2017-02-21T14:50:26.495Z",
;        "version": 1487688626495,
;        "is_deleted": false,
;        "present_at_all_locations": true,
;        "category_data": {
;          "name": "Beverages"
;        }
;      },
;      {
;        "type": "TAX",
;        "id": "L5R47DGBZOOVKCAFIXC56AEN",
;        "updated_at": "2017-02-21T14:50:26.495Z",
;        "version": 1487688626495,
;        "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 $sCategory_dataName
Local $sTax_dataName
Local $sTax_dataCalculation_phase
Local $sTax_dataInclusion_type
Local $sTax_dataPercentage
Local $bTax_dataEnabled

Local $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")
    $sCategory_dataName = $oJResp.StringOf("objects[i].category_data.name")
    $sTax_dataName = $oJResp.StringOf("objects[i].tax_data.name")
    $sTax_dataCalculation_phase = $oJResp.StringOf("objects[i].tax_data.calculation_phase")
    $sTax_dataInclusion_type = $oJResp.StringOf("objects[i].tax_data.inclusion_type")
    $sTax_dataPercentage = $oJResp.StringOf("objects[i].tax_data.percentage")
    $bTax_dataEnabled = $oJResp.BoolOf("objects[i].tax_data.enabled")
    $i = $i + 1
Wend