Lua
Lua
Square API - Batch Retrieve Catalog Objects
See more Square Examples
Returns a set of objects based on the provided ID.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/batch-retrieve \
-- -X POST \
-- -H 'Square-Version: 2020-07-22' \
-- -H 'Authorization: Bearer ACCESS_TOKEN' \
-- -H 'Content-Type: application/json' \
-- -d '{
-- "object_ids": [
-- "W62UWFY35CWMYGVWK6TWJDNI",
-- "AA27W3M2GGTF3H6AVPNB77CK"
-- ],
-- "include_related_objects": true
-- }'
-- 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_ids": [
-- "W62UWFY35CWMYGVWK6TWJDNI",
-- "AA27W3M2GGTF3H6AVPNB77CK"
-- ],
-- "include_related_objects": true
-- }
local json = chilkat.JsonObject.new()
local i = 0
json.i = i
json:update_string("object_ids[i]", "W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
json.i = i
json:update_string("object_ids[i]", "AA27W3M2GGTF3H6AVPNB77CK")
json:update_bool("include_related_objects", true)
-- 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/batch-retrieve", 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": "W62UWFY35CWMYGVWK6TWJDNI",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_data": {
-- "name": "Tea",
-- "description": "Hot Leaf Juice",
-- "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
-- "tax_ids": [
-- "HURXQOOAIC4IZSI2BEXQRYFY"
-- ],
-- "variations": [
-- {
-- "type": "ITEM_VARIATION",
-- "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_variation_data": {
-- "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
-- "name": "Mug",
-- "ordinal": 0,
-- "pricing_type": "FIXED_PRICING",
-- "price_money": {
-- "amount": 150,
-- "currency": "USD"
-- }
-- }
-- }
-- ]
-- }
-- },
-- {
-- "type": "ITEM",
-- "id": "AA27W3M2GGTF3H6AVPNB77CK",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_data": {
-- "name": "Coffee",
-- "description": "Hot Bean Juice",
-- "category_id": "BJNQCF2FJ6S6UIDT65ABHLRX",
-- "tax_ids": [
-- "HURXQOOAIC4IZSI2BEXQRYFY"
-- ],
-- "variations": [
-- {
-- "type": "ITEM_VARIATION",
-- "id": "LBTYIHNHU52WOIHWT7SNRIYH",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_variation_data": {
-- "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
-- "name": "Regular",
-- "ordinal": 0,
-- "pricing_type": "FIXED_PRICING",
-- "price_money": {
-- "amount": 250,
-- "currency": "USD"
-- }
-- }
-- },
-- {
-- "type": "ITEM_VARIATION",
-- "id": "PKYIC7HGGKW5CYVSCVDEIMHY",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "item_variation_data": {
-- "item_id": "AA27W3M2GGTF3H6AVPNB77CK",
-- "name": "Large",
-- "ordinal": 1,
-- "pricing_type": "FIXED_PRICING",
-- "price_money": {
-- "amount": 350,
-- "currency": "USD"
-- }
-- }
-- }
-- ]
-- }
-- }
-- ],
-- "related_objects": [
-- {
-- "type": "CATEGORY",
-- "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "is_deleted": false,
-- "present_at_all_locations": true,
-- "category_data": {
-- "name": "Beverages"
-- }
-- },
-- {
-- "type": "TAX",
-- "id": "HURXQOOAIC4IZSI2BEXQRYFY",
-- "updated_at": "2016-11-16T22:25:24.878Z",
-- "version": 1479335124878,
-- "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 item_dataName = ""
local item_dataDescription = ""
local item_dataCategory_id = ""
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_dataPricing_type = ""
local item_variation_dataPrice_moneyAmount = 0
local item_variation_dataPrice_moneyCurrency = ""
local category_dataName = ""
local tax_dataName = ""
local tax_dataCalculation_phase = ""
local tax_dataInclusion_type = ""
local tax_dataPercentage = ""
local tax_dataEnabled = false
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")
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_dataPricing_type = jResp:string_of("objects[i].item_data.variations[j].item_variation_data.pricing_type")
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")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp:size_of_array("related_objects")
while i < count_i do
jResp.i = i
v_type = jResp:string_of("related_objects[i].type")
id = jResp:string_of("related_objects[i].id")
updated_at = jResp:string_of("related_objects[i].updated_at")
version = jResp:int_of("related_objects[i].version")
is_deleted = jResp:bool_of("related_objects[i].is_deleted")
present_at_all_locations = jResp:bool_of("related_objects[i].present_at_all_locations")
category_dataName = jResp:string_of("related_objects[i].category_data.name")
tax_dataName = jResp:string_of("related_objects[i].tax_data.name")
tax_dataCalculation_phase = jResp:string_of("related_objects[i].tax_data.calculation_phase")
tax_dataInclusion_type = jResp:string_of("related_objects[i].tax_data.inclusion_type")
tax_dataPercentage = jResp:string_of("related_objects[i].tax_data.percentage")
tax_dataEnabled = jResp:bool_of("related_objects[i].tax_data.enabled")
i = i + 1
end