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

Objective-C

#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoRest.h>
#import <NSString.h>

BOOL success = NO;

// 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)
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
[jsonToken LoadFile: @"qa_data/tokens/paypal.json"];

// Build the Authorization request header field value.
CkoStringBuilder *sbAuth = [[CkoStringBuilder alloc] init];
// token_type should be "Bearer"
[sbAuth Append: [jsonToken StringOf: @"token_type"]];
[sbAuth Append: @" "];
[sbAuth Append: [jsonToken StringOf: @"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.
CkoRest *rest = [[CkoRest alloc] init];
BOOL bAutoReconnect = YES;
success = [rest Connect: @"api.sandbox.paypal.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    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..
// ----------------------------------------------------------------------------------------------

[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];

NSString *invoiceId = @"INV2-29Z4-EB7M-MUCY-327J";

CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/v1/invoicing/invoices/"];
[sbPath Append: invoiceId];

// Send the DELETE request and get the JSON response.
CkoStringBuilder *sbJsonResponse = [[CkoStringBuilder alloc] init];
success = [rest FullRequestNoBodySb: @"DELETE" uriPath: [sbPath GetAsString] sb: sbJsonResponse];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// A 204 response is expected for success.
NSLog(@"%@%d",@"Response Status Code = ",[rest.ResponseStatusCode intValue]);

// Did we get a 204 success response?
if ([rest.ResponseStatusCode intValue] != 204) {
    NSLog(@"%@",@"Failed.");
    return;
}

NSLog(@"%@",@"Received successful 204 status code response.");
NSLog(@"%@",@"There is no response body, as expected.");
NSLog(@"%@",@"Success.");