AutoIt
AutoIt
Square API - Search Catalog Objects
See more Square Examples
Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,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/search \
; -X POST \
; -H 'Square-Version: 2020-07-22' \
; -H 'Authorization: Bearer ACCESS_TOKEN' \
; -H 'Content-Type: application/json' \
; -d '{
; "object_types": [
; "ITEM"
; ],
; "query": {
; "prefix_query": {
; "attribute_name": "name",
; "attribute_prefix": "tea"
; }
; },
; "limit": 100
; }'
; 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_types": [
; "ITEM"
; ],
; "query": {
; "prefix_query": {
; "attribute_name": "name",
; "attribute_prefix": "tea"
; }
; },
; "limit": 100
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("object_types[0]","ITEM")
$oJson.UpdateString("query.prefix_query.attribute_name","name")
$oJson.UpdateString("query.prefix_query.attribute_prefix","tea")
$oJson.UpdateInt("limit",100)
; 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/search",$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": "X5DZ5NWWAQ44CKBLKIFQGOWK",
; "updated_at": "2017-10-26T15:41:32.337Z",
; "version": 1509032492337,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_data": {
; "name": "Tea - Black",
; "description": "A delicious blend of black tea.",
; "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
; "product_type": "REGULAR",
; "tax_ids": [
; "ZXITPM6RWHZ7GZ7EIP3YKECM"
; ],
; "variations": [
; {
; "type": "ITEM_VARIATION",
; "id": "5GSZPX6EU7MM75S57OONG3V5",
; "updated_at": "2017-10-26T15:27:31.626Z",
; "version": 1509031651626,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_variation_data": {
; "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
; "name": "Regular",
; "ordinal": 1,
; "price_money": {
; "amount": 150,
; "currency": "USD"
; },
; "pricing_type": "FIXED_PRICING"
; }
; },
; {
; "type": "ITEM_VARIATION",
; "id": "XVLBN7DU6JTWHJTG5F265B43",
; "updated_at": "2017-10-26T15:27:31.626Z",
; "version": 1509031651626,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_variation_data": {
; "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
; "name": "Large",
; "ordinal": 2,
; "price_money": {
; "amount": 225,
; "currency": "USD"
; },
; "pricing_type": "FIXED_PRICING"
; }
; }
; ],
; "visibility": "PRIVATE"
; }
; },
; {
; "type": "ITEM",
; "id": "NNNEM3LA656Q46NXLWCNI7S5",
; "updated_at": "2017-10-26T15:41:23.232Z",
; "version": 1509032483232,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_data": {
; "name": "Tea - Green",
; "description": "Relaxing green herbal tea.",
; "category_id": "E7CLE5RZZ744BHWVQQEAHI2C",
; "product_type": "REGULAR",
; "tax_ids": [
; "ZXITPM6RWHZ7GZ7EIP3YKECM"
; ],
; "variations": [
; {
; "type": "ITEM_VARIATION",
; "id": "FHYBVIA6NVBCSOVETA62WEA4",
; "updated_at": "2017-10-26T15:29:00.524Z",
; "version": 1509031740524,
; "is_deleted": false,
; "present_at_all_locations": true,
; "item_variation_data": {
; "item_id": "NNNEM3LA656Q46NXLWCNI7S5",
; "name": "Regular",
; "ordinal": 1,
; "price_money": {
; "amount": 150,
; "currency": "USD"
; },
; "pricing_type": "FIXED_PRICING"
; }
; }
; ],
; "visibility": "PRIVATE"
; }
; }
; ]
; }
; 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 $sItem_dataProduct_type
Local $sItem_dataVisibility
Local $iJ
Local $iCount_j
Local $strVal
Local $sItem_variation_dataItem_id
Local $sItem_variation_dataName
Local $item_variation_dataOrdinal
Local $item_variation_dataPrice_moneyAmount
Local $sItem_variation_dataPrice_moneyCurrency
Local $sItem_variation_dataPricing_type
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")
$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")
$sItem_dataProduct_type = $oJResp.StringOf("objects[i].item_data.product_type")
$sItem_dataVisibility = $oJResp.StringOf("objects[i].item_data.visibility")
$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")
$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")
$sItem_variation_dataPricing_type = $oJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend