(Perl) Square API - List Catalog

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog.

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

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# Implements the following CURL command:

# curl https://connect.squareup.com/v2/catalog/list?types=category%2Ctax \
#   -H 'Square-Version: 2020-07-22' \
#   -H 'Authorization: Bearer ACCESS_TOKEN' \
#   -H 'Content-Type: application/json'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Adds the "Authorization: Bearer ACCESS_TOKEN" header.
$http->put_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
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "objects": [
#     {
#       "type": "CATEGORY",
#       "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
#       "updated_at": "2017-02-21T14:50:26.495Z",
#       "version": 1487688626495,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "category_data": {
#         "name": "Beverages"
#       }
#     },
#     {
#       "type": "TAX",
#       "id": "L5R47DGBZOOVKCAFIXC56AEN",
#       "updated_at": "2017-02-21T14:50:26.495Z",
#       "version": 1487688626495,
#       "is_deleted": false,
#       "present_at_all_locations": true,
#       "tax_data": {
#         "name": "Sales Tax",
#         "calculation_phase": "TAX_SUBTOTAL_PHASE",
#         "inclusion_type": "ADDITIVE",
#         "percentage": "5.0",
#         "enabled": true
#       }
#     }
#   ]
# }

# 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->put_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");
    $category_dataName = $jResp->stringOf("objects[i].category_data.name");
    $tax_dataName = $jResp->stringOf("objects[i].tax_data.name");
    $tax_dataCalculation_phase = $jResp->stringOf("objects[i].tax_data.calculation_phase");
    $tax_dataInclusion_type = $jResp->stringOf("objects[i].tax_data.inclusion_type");
    $tax_dataPercentage = $jResp->stringOf("objects[i].tax_data.percentage");
    $tax_dataEnabled = $jResp->BoolOf("objects[i].tax_data.enabled");
    $i = $i + 1;
}