Lua

Square API - Batch Delete Catalog Objects

See more Square Examples

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. 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/batch-delete \
--   -X POST \
--   -H 'Square-Version: 2020-07-22' \
--   -H 'Authorization: Bearer ACCESS_TOKEN' \
--   -H 'Content-Type: application/json' \
--   -d '{
--     "object_ids": [
--       "W62UWFY35CWMYGVWK6TWJDNI",
--       "AA27W3M2GGTF3H6AVPNB77CK"
--     ]
--   }'

-- 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"
--   ]
-- }

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

-- 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-delete", 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)

-- {
--   "deleted_object_ids": [
--     "W62UWFY35CWMYGVWK6TWJDNI",
--     "AA27W3M2GGTF3H6AVPNB77CK"
--   ],
--   "deleted_at": "2016-11-16T22:25:24.878Z"
-- }

-- 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 strVal = ""

local deleted_at = jResp:string_of("deleted_at")
i = 0
local count_i = jResp:size_of_array("deleted_object_ids")
while i < count_i do
    jResp.i = i
    strVal = jResp:string_of("deleted_object_ids[i]")
    i = i + 1
end