(PHP ActiveX) 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 Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("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 new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('object_types[0]','ITEM');
$json->UpdateString('query.prefix_query.attribute_name','name');
$json->UpdateString('query.prefix_query.attribute_prefix','tea');
$json->UpdateInt('limit',100);

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

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://connect.squareupsandbox.com/v2/catalog/search','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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;
$count_i = $jResp->SizeOfArray('objects');
while ($i < $count_i) {
    $jResp->I = $i;
    $v_type = $jResp->stringOf('objects[i].type');
    $id = $jResp->stringOf('objects[i].id');
    $updated_at = $jResp->stringOf('objects[i].updated_at');
    $version = $jResp->IntOf('objects[i].version');
    $is_deleted = $jResp->BoolOf('objects[i].is_deleted');
    $present_at_all_locations = $jResp->BoolOf('objects[i].present_at_all_locations');
    $item_dataName = $jResp->stringOf('objects[i].item_data.name');
    $item_dataDescription = $jResp->stringOf('objects[i].item_data.description');
    $item_dataCategory_id = $jResp->stringOf('objects[i].item_data.category_id');
    $item_dataProduct_type = $jResp->stringOf('objects[i].item_data.product_type');
    $item_dataVisibility = $jResp->stringOf('objects[i].item_data.visibility');
    $j = 0;
    $count_j = $jResp->SizeOfArray('objects[i].item_data.tax_ids');
    while ($j < $count_j) {
        $jResp->J = $j;
        $strVal = $jResp->stringOf('objects[i].item_data.tax_ids[j]');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('objects[i].item_data.variations');
    while ($j < $count_j) {
        $jResp->J = $j;
        $v_type = $jResp->stringOf('objects[i].item_data.variations[j].type');
        $id = $jResp->stringOf('objects[i].item_data.variations[j].id');
        $updated_at = $jResp->stringOf('objects[i].item_data.variations[j].updated_at');
        $version = $jResp->IntOf('objects[i].item_data.variations[j].version');
        $is_deleted = $jResp->BoolOf('objects[i].item_data.variations[j].is_deleted');
        $present_at_all_locations = $jResp->BoolOf('objects[i].item_data.variations[j].present_at_all_locations');
        $item_variation_dataItem_id = $jResp->stringOf('objects[i].item_data.variations[j].item_variation_data.item_id');
        $item_variation_dataName = $jResp->stringOf('objects[i].item_data.variations[j].item_variation_data.name');
        $item_variation_dataOrdinal = $jResp->IntOf('objects[i].item_data.variations[j].item_variation_data.ordinal');
        $item_variation_dataPrice_moneyAmount = $jResp->IntOf('objects[i].item_data.variations[j].item_variation_data.price_money.amount');
        $item_variation_dataPrice_moneyCurrency = $jResp->stringOf('objects[i].item_data.variations[j].item_variation_data.price_money.currency');
        $item_variation_dataPricing_type = $jResp->stringOf('objects[i].item_data.variations[j].item_variation_data.pricing_type');
        $j = $j + 1;
    }

    $i = $i + 1;
}


?>