Lua
Lua
Square API - Search Catalog Objects
See more Square Examples
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,Chilkat Lua Downloads
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/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
-- }
local json = chilkat.JsonObject.new()
json:update_string("object_types[0]", "ITEM")
json:update_string("query.prefix_query.attribute_name", "name")
json:update_string("query.prefix_query.attribute_prefix", "tea")
json:update_int("limit", 100)
-- Adds the "Authorization: Bearer ACCESS_TOKEN" header.
http.auth_token = "ACCESS_TOKEN"
http:set_request_header("Square-Version", "2020-07-22")
-- This example uses the sandbox: connect.squareupsandbox.com
-- Production should use connect.squareup.com
local resp = chilkat.HttpResponse.new()
local success = http:http_json("POST", "https://connect.squareupsandbox.com/v2/catalog/search", json, "application/json", resp)
if not success then
print(http.last_error_text)
return
end
local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false
print("Response Body:")
print(jResp:emit())
local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
print("Response Header:")
print(resp.header)
print("Failed.")
return
end
-- 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
local v_type = ""
local id = ""
local updated_at = ""
local version = 0
local is_deleted = false
local present_at_all_locations = false
local item_dataName = ""
local item_dataDescription = ""
local item_dataCategory_id = ""
local item_dataProduct_type = ""
local item_dataVisibility = ""
local j = 0
local count_j = 0
local strVal = ""
local item_variation_dataItem_id = ""
local item_variation_dataName = ""
local item_variation_dataOrdinal = 0
local item_variation_dataPrice_moneyAmount = 0
local item_variation_dataPrice_moneyCurrency = ""
local item_variation_dataPricing_type = ""
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")
item_dataName = jResp:string_of("objects[i].item_data.name")
item_dataDescription = jResp:string_of("objects[i].item_data.description")
item_dataCategory_id = jResp:string_of("objects[i].item_data.category_id")
item_dataProduct_type = jResp:string_of("objects[i].item_data.product_type")
item_dataVisibility = jResp:string_of("objects[i].item_data.visibility")
j = 0
count_j = jResp:size_of_array("objects[i].item_data.tax_ids")
while j < count_j do
jResp.j = j
strVal = jResp:string_of("objects[i].item_data.tax_ids[j]")
j = j + 1
end
j = 0
count_j = jResp:size_of_array("objects[i].item_data.variations")
while j < count_j do
jResp.j = j
v_type = jResp:string_of("objects[i].item_data.variations[j].type")
id = jResp:string_of("objects[i].item_data.variations[j].id")
updated_at = jResp:string_of("objects[i].item_data.variations[j].updated_at")
version = jResp:int_of("objects[i].item_data.variations[j].version")
is_deleted = jResp:bool_of("objects[i].item_data.variations[j].is_deleted")
present_at_all_locations = jResp:bool_of("objects[i].item_data.variations[j].present_at_all_locations")
item_variation_dataItem_id = jResp:string_of("objects[i].item_data.variations[j].item_variation_data.item_id")
item_variation_dataName = jResp:string_of("objects[i].item_data.variations[j].item_variation_data.name")
item_variation_dataOrdinal = jResp:int_of("objects[i].item_data.variations[j].item_variation_data.ordinal")
item_variation_dataPrice_moneyAmount = jResp:int_of("objects[i].item_data.variations[j].item_variation_data.price_money.amount")
item_variation_dataPrice_moneyCurrency = jResp:string_of("objects[i].item_data.variations[j].item_variation_data.price_money.currency")
item_variation_dataPricing_type = jResp:string_of("objects[i].item_data.variations[j].item_variation_data.pricing_type")
j = j + 1
end
i = i + 1
end