(Visual FoxPro) Square API - Search Catalog Objects

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,

For more information, see https://developer.squareup.com/reference/square/catalog-api/search-catalog-objects

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_type
LOCAL lcId
LOCAL lcUpdated_at
LOCAL lnVersion
LOCAL lnIs_deleted
LOCAL lnPresent_at_all_locations
LOCAL lcItem_dataName
LOCAL lcItem_dataDescription
LOCAL lcItem_dataCategory_id
LOCAL lcItem_dataProduct_type
LOCAL lcItem_dataVisibility
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcItem_variation_dataItem_id
LOCAL lcItem_variation_dataName
LOCAL lnItem_variation_dataOrdinal
LOCAL lnItem_variation_dataPrice_moneyAmount
LOCAL lcItem_variation_dataPrice_moneyCurrency
LOCAL lcItem_variation_dataPricing_type
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("object_types[0]","ITEM")
loJson.UpdateString("query.prefix_query.attribute_name","name")
loJson.UpdateString("query.prefix_query.attribute_prefix","tea")
loJson.UpdateInt("limit",100)

* Adds the "Authorization: Bearer ACCESS_TOKEN" header.
loHttp.AuthToken = "ACCESS_TOKEN"
loHttp.SetRequestHeader("Square-Version","2020-07-22")
loHttp.SetRequestHeader("Content-Type","application/json")

* This example uses the sandbox: connect.squareupsandbox.com
* Production should use connect.squareup.com
loResp = loHttp.PostJson3("https://connect.squareupsandbox.com/v2/catalog/search","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

i = 0
lnCount_i = loJResp.SizeOfArray("objects")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcV_type = loJResp.StringOf("objects[i].type")
    lcId = loJResp.StringOf("objects[i].id")
    lcUpdated_at = loJResp.StringOf("objects[i].updated_at")
    lnVersion = loJResp.IntOf("objects[i].version")
    lnIs_deleted = loJResp.BoolOf("objects[i].is_deleted")
    lnPresent_at_all_locations = loJResp.BoolOf("objects[i].present_at_all_locations")
    lcItem_dataName = loJResp.StringOf("objects[i].item_data.name")
    lcItem_dataDescription = loJResp.StringOf("objects[i].item_data.description")
    lcItem_dataCategory_id = loJResp.StringOf("objects[i].item_data.category_id")
    lcItem_dataProduct_type = loJResp.StringOf("objects[i].item_data.product_type")
    lcItem_dataVisibility = loJResp.StringOf("objects[i].item_data.visibility")
    j = 0
    lnCount_j = loJResp.SizeOfArray("objects[i].item_data.tax_ids")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcStrVal = loJResp.StringOf("objects[i].item_data.tax_ids[j]")
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("objects[i].item_data.variations")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcV_type = loJResp.StringOf("objects[i].item_data.variations[j].type")
        lcId = loJResp.StringOf("objects[i].item_data.variations[j].id")
        lcUpdated_at = loJResp.StringOf("objects[i].item_data.variations[j].updated_at")
        lnVersion = loJResp.IntOf("objects[i].item_data.variations[j].version")
        lnIs_deleted = loJResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
        lnPresent_at_all_locations = loJResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
        lcItem_variation_dataItem_id = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
        lcItem_variation_dataName = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
        lnItem_variation_dataOrdinal = loJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
        lnItem_variation_dataPrice_moneyAmount = loJResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
        lcItem_variation_dataPrice_moneyCurrency = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
        lcItem_variation_dataPricing_type = loJResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
        j = j + 1
    ENDDO
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp