B4X

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

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("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"
'    ]
'  }

Dim json As ChilkatJsonObject
json.Initialize
Dim i As Int = 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
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://connect.squareupsandbox.com/v2/catalog/batch-delete", json, "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

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

Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(resp.Header)
    Log("Failed.")
    Return
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

Dim strVal As String

Dim deleted_at As String = jResp.StringOf("deleted_at")
i = 0
Dim count_i As Int = jResp.SizeOfArray("deleted_object_ids")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("deleted_object_ids[i]")
    i = i + 1
Loop