(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

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

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject

i = 0
json.I = i
Dim success As Boolean
success = json.UpdateString("object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
i = i + 1
json.I = i
success = json.UpdateString("object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")

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

' This example uses the sandbox: connect.squareupsandbox.com
' Production should use connect.squareup.com

Set resp = http.PostJson3("https://connect.squareupsandbox.com/v2/catalog/batch-delete","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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


deleted_at = jResp.StringOf("deleted_at")
i = 0

count_i = jResp.SizeOfArray("deleted_object_ids")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("deleted_object_ids[i]")
    i = i + 1
Loop