Lua

Square API - List Catalog

See more Square Examples

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. Lua

local chilkat = require("chilkat")

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

local http = chilkat.Http.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.auth_token = "ACCESS_TOKEN"
http:set_request_header("Square-Version", "2020-07-22")
http:set_request_header("Content-Type", "application/json")

-- This example uses the sandbox: connect.squareupsandbox.com
-- Production should use connect.squareup.com
local sbResponseBody = chilkat.StringBuilder.new()
local success = http:quick_get_sb("https://connect.squareupsandbox.com/v2/catalog/list?types=item,category,tax,image", sbResponseBody)
if not success then
    print(http.last_error_text)
    return
end

local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

local respStatusCode = http.last_status
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(http.last_header)
    print("Failed.")
    return
end

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

local v_type = ""
local id = ""
local updated_at = ""
local version = 0
local is_deleted = false
local present_at_all_locations = false
local category_dataName = ""
local tax_dataName = ""
local tax_dataCalculation_phase = ""
local tax_dataInclusion_type = ""
local tax_dataPercentage = ""
local tax_dataEnabled = false

local i = 0
local count_i = jResp:size_of_array("objects")
while i < count_i do
    jResp.i = i
    v_type = jResp:string_of("objects[i].type")
    id = jResp:string_of("objects[i].id")
    updated_at = jResp:string_of("objects[i].updated_at")
    version = jResp:int_of("objects[i].version")
    is_deleted = jResp:bool_of("objects[i].is_deleted")
    present_at_all_locations = jResp:bool_of("objects[i].present_at_all_locations")
    category_dataName = jResp:string_of("objects[i].category_data.name")
    tax_dataName = jResp:string_of("objects[i].tax_data.name")
    tax_dataCalculation_phase = jResp:string_of("objects[i].tax_data.calculation_phase")
    tax_dataInclusion_type = jResp:string_of("objects[i].tax_data.inclusion_type")
    tax_dataPercentage = jResp:string_of("objects[i].tax_data.percentage")
    tax_dataEnabled = jResp:bool_of("objects[i].tax_data.enabled")
    i = i + 1
end