(PowerBuilder) 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

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_type
string ls_Id
string ls_Updated_at
integer li_Version
integer li_Is_deleted
integer li_Present_at_all_locations
string ls_Item_dataName
string ls_Item_dataDescription
string ls_Item_dataCategory_id
string ls_Item_dataProduct_type
string ls_Item_dataVisibility
integer j
integer li_Count_j
string ls_StrVal
string ls_Item_variation_dataItem_id
string ls_Item_variation_dataName
integer li_Item_variation_dataOrdinal
integer li_Item_variation_dataPrice_moneyAmount
string ls_Item_variation_dataPrice_moneyCurrency
string ls_Item_variation_dataPricing_type
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("object_types[0]","ITEM")
loo_Json.UpdateString("query.prefix_query.attribute_name","name")
loo_Json.UpdateString("query.prefix_query.attribute_prefix","tea")
loo_Json.UpdateInt("limit",100)

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

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loo_Resp = loo_Http.PostJson3("https://connect.squareupsandbox.com/v2/catalog/search","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

// 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
li_Count_i = loo_JResp.SizeOfArray("objects")
do while i < li_Count_i
    loo_JResp.I = i
    ls_V_type = loo_JResp.StringOf("objects[i].type")
    ls_Id = loo_JResp.StringOf("objects[i].id")
    ls_Updated_at = loo_JResp.StringOf("objects[i].updated_at")
    li_Version = loo_JResp.IntOf("objects[i].version")
    li_Is_deleted = loo_JResp.BoolOf("objects[i].is_deleted")
    li_Present_at_all_locations = loo_JResp.BoolOf("objects[i].present_at_all_locations")
    ls_Item_dataName = loo_JResp.StringOf("objects[i].item_data.name")
    ls_Item_dataDescription = loo_JResp.StringOf("objects[i].item_data.description")
    ls_Item_dataCategory_id = loo_JResp.StringOf("objects[i].item_data.category_id")
    ls_Item_dataProduct_type = loo_JResp.StringOf("objects[i].item_data.product_type")
    ls_Item_dataVisibility = loo_JResp.StringOf("objects[i].item_data.visibility")
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("objects[i].item_data.tax_ids")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_StrVal = loo_JResp.StringOf("objects[i].item_data.tax_ids[j]")
        j = j + 1
    loop
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("objects[i].item_data.variations")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_V_type = loo_JResp.StringOf("objects[i].item_data.variations[j].type")
        ls_Id = loo_JResp.StringOf("objects[i].item_data.variations[j].id")
        ls_Updated_at = loo_JResp.StringOf("objects[i].item_data.variations[j].updated_at")
        li_Version = loo_JResp.IntOf("objects[i].item_data.variations[j].version")
        li_Is_deleted = loo_JResp.BoolOf("objects[i].item_data.variations[j].is_deleted")
        li_Present_at_all_locations = loo_JResp.BoolOf("objects[i].item_data.variations[j].present_at_all_locations")
        ls_Item_variation_dataItem_id = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.item_id")
        ls_Item_variation_dataName = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.name")
        li_Item_variation_dataOrdinal = loo_JResp.IntOf("objects[i].item_data.variations[j].item_variation_data.ordinal")
        li_Item_variation_dataPrice_moneyAmount = loo_JResp.IntOf("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
        ls_Item_variation_dataPrice_moneyCurrency = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
        ls_Item_variation_dataPricing_type = loo_JResp.StringOf("objects[i].item_data.variations[j].item_variation_data.pricing_type")
        j = j + 1
    loop
    i = i + 1
loop


destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp