CkPython

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.

CkPython

import sys
import chilkat

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 = chilkat.CkJsonObject()
jsonToken.LoadFile("qa_data/tokens/paypal.json")

# Build the Authorization request header field value.
sbAuth = chilkat.CkStringBuilder()
# 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.
rest = chilkat.CkRest()
bAutoReconnect = True
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

# ----------------------------------------------------------------------------------------------
# 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",sbAuth.getAsString())

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

sbPath = chilkat.CkStringBuilder()
sbPath.Append("/v1/invoicing/invoices/")
sbPath.Append(invoiceId)

# Send the DELETE request and get the JSON response.
sbJsonResponse = chilkat.CkStringBuilder()
success = rest.FullRequestNoBodySb("DELETE",sbPath.getAsString(),sbJsonResponse)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

# A 204 response is expected for success.
print("Response Status Code = " + str(rest.get_ResponseStatusCode()))

# Did we get a 204 success response?
if (rest.get_ResponseStatusCode() != 204):
    print("Failed.")
    sys.exit()

print("Received successful 204 status code response.")
print("There is no response body, as expected.")
print("Success.")