(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// 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
// }

loJson = createobject("CkJsonObject")
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 = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
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")
    llIs_deleted = loJResp.BoolOf("objects[i].is_deleted")
    llPresent_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")
        llIs_deleted = loJResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
        llPresent_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