Unicode C

PayPal - Delete Draft Invoice

See more PayPal Examples

Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can cancel the invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

Unicode C

#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkRestW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkJsonObjectW jsonToken;
    HCkStringBuilderW sbAuth;
    HCkRestW rest;
    BOOL bAutoReconnect;
    const wchar_t *invoiceId;
    HCkStringBuilderW sbPath;
    HCkStringBuilderW sbJsonResponse;

    success = FALSE;

    // Note: Requires Chilkat v9.5.0.65 or greater.

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Load our previously obtained access token. (see PayPal OAuth2 Access Token)
    jsonToken = CkJsonObjectW_Create();
    CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/paypal.json");

    // Build the Authorization request header field value.
    sbAuth = CkStringBuilderW_Create();
    // token_type should be "Bearer"
    CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"token_type"));
    CkStringBuilderW_Append(sbAuth,L" ");
    CkStringBuilderW_Append(sbAuth,CkJsonObjectW_stringOf(jsonToken,L"access_token"));

    // Make the initial connection.
    // A single REST object, once connected, can be used for many PayPal REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    rest = CkRestW_Create();
    bAutoReconnect = TRUE;
    success = CkRestW_Connect(rest,L"api.sandbox.paypal.com",443,TRUE,bAutoReconnect);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkJsonObjectW_Dispose(jsonToken);
        CkStringBuilderW_Dispose(sbAuth);
        CkRestW_Dispose(rest);
        return;
    }

    // ----------------------------------------------------------------------------------------------
    // The code above this comment could be placed inside a function/subroutine within the application
    // because the connection does not need to be made for every request.  Once the connection is made
    // the app may send many requests..
    // ----------------------------------------------------------------------------------------------

    CkRestW_AddHeader(rest,L"Authorization",CkStringBuilderW_getAsString(sbAuth));

    invoiceId = L"INV2-29Z4-EB7M-MUCY-327J";

    sbPath = CkStringBuilderW_Create();
    CkStringBuilderW_Append(sbPath,L"/v1/invoicing/invoices/");
    CkStringBuilderW_Append(sbPath,invoiceId);

    // Send the DELETE request and get the JSON response.
    sbJsonResponse = CkStringBuilderW_Create();
    success = CkRestW_FullRequestNoBodySb(rest,L"DELETE",CkStringBuilderW_getAsString(sbPath),sbJsonResponse);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkJsonObjectW_Dispose(jsonToken);
        CkStringBuilderW_Dispose(sbAuth);
        CkRestW_Dispose(rest);
        CkStringBuilderW_Dispose(sbPath);
        CkStringBuilderW_Dispose(sbJsonResponse);
        return;
    }

    // A 204 response is expected for success.
    wprintf(L"Response Status Code = %d\n",CkRestW_getResponseStatusCode(rest));

    // Did we get a 204 success response?
    if (CkRestW_getResponseStatusCode(rest) != 204) {
        wprintf(L"Failed.\n");
        CkJsonObjectW_Dispose(jsonToken);
        CkStringBuilderW_Dispose(sbAuth);
        CkRestW_Dispose(rest);
        CkStringBuilderW_Dispose(sbPath);
        CkStringBuilderW_Dispose(sbJsonResponse);
        return;
    }

    wprintf(L"Received successful 204 status code response.\n");
    wprintf(L"There is no response body, as expected.\n");
    wprintf(L"Success.\n");


    CkJsonObjectW_Dispose(jsonToken);
    CkStringBuilderW_Dispose(sbAuth);
    CkRestW_Dispose(rest);
    CkStringBuilderW_Dispose(sbPath);
    CkStringBuilderW_Dispose(sbJsonResponse);

    }