PowerShell

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. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.Http

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

$json = New-Object Chilkat.JsonObject
$i = 0
$json.I = $i
$json.UpdateString("object_ids[i]","W62UWFY35CWMYGVWK6TWJDNI")
$i = $i + 1
$json.I = $i
$json.UpdateString("object_ids[i]","AA27W3M2GGTF3H6AVPNB77CK")

# Adds the "Authorization: Bearer ACCESS_TOKEN" header.
$http.AuthToken = "ACCESS_TOKEN"
$http.SetRequestHeader("Square-Version","2020-07-22")

# This example uses the sandbox: connect.squareupsandbox.com
# Production should use connect.squareup.com
$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpJson("POST","https://connect.squareupsandbox.com/v2/catalog/batch-delete",$json,"application/json",$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")
    exit
}

# 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")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("deleted_object_ids[i]")
    $i = $i + 1
}