PureBasic

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

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    CkHttp::setCkAuthToken(http, "ACCESS_TOKEN")
    CkHttp::ckSetRequestHeader(http,"Square-Version","2020-07-22")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

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

    CkHttp::ckSetUrlVar(http,"object_id","2PTZYUOFGGDMT75UZLHQAPAC")
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpNoBody(http,"DELETE","https://connect.squareupsandbox.com/v2/catalog/object/{$object_id}",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

    strVal.s

    deleted_at.s = CkJsonObject::ckStringOf(jResp,"deleted_at")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"deleted_object_ids")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"deleted_object_ids[i]")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure