(Lianja) Square API - Batch Delete Catalog Objects

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response.

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

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

loJson = createobject("CkJsonObject")
i = 0
loJson.I = i
loJson.UpdateString("object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
loJson.I = i
loJson.UpdateString("object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")

// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
loHttp.AuthToken = "ACCESS_TOKEN"
loHttp.SetRequestHeader("Square-Version","2020-07-22")
loHttp.SetRequestHeader("Content-Type","application/json")

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
loResp = loHttp.PostJson3("https://connect.squareupsandbox.com/v2/catalog/batch-delete","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

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

lcDeleted_at = loJResp.StringOf("deleted_at")
i = 0
lnCount_i = loJResp.SizeOfArray("deleted_object_ids")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("deleted_object_ids[i]")
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp