Lianja

Square API - Delete Catalog Object

See more Square Examples

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. Lianja

llSuccess = .F.

// 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/object/object_id0 \
//   -X DELETE \
//   -H 'Square-Version: 2020-07-22' \
//   -H 'Authorization: Bearer ACCESS_TOKEN' \
//   -H 'Content-Type: application/json'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

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

loHttp.SetUrlVar("object_id","2PTZYUOFGGDMT75UZLHQAPAC")
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpNoBody("DELETE","https://connect.squareupsandbox.com/v2/catalog/object/{$object_id}",loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loResp
    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 loHttp
    release loResp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "deleted_object_ids": [
//     "2PTZYUOFGGDMT75UZLHQAPAC",
//     "KQLFFHA6K6J3YQAQAWDQAL57"
//   ],
//   "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 loResp
release loSbResponseBody
release loJResp