CkPython
CkPython
PayPal - Update Invoice
See more PayPal Examples
Update a PayPal invoice.Note: This example requires Chilkat v9.5.0.65 or greater.
See also PayPal Update Invoice REST API Reference
Chilkat CkPython Downloads
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..
# ----------------------------------------------------------------------------------------------
# First create the JSON with updated information:
json = chilkat.CkJsonObject()
json.put_EmitCompact(False)
json.UpdateString("merchant_info.email","smith-facilitator@chilkatsoft.com")
json.UpdateString("merchant_info.first_name","Joe")
json.UpdateString("merchant_info.last_name","Facilitator")
json.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
json.UpdateString("merchant_info.phone.country_code","001")
json.UpdateString("merchant_info.phone.national_number","5032141716")
json.UpdateString("merchant_info.address.line1","1234 Main St.")
json.UpdateString("merchant_info.address.city","Portland")
json.UpdateString("merchant_info.address.state","OR")
json.UpdateString("merchant_info.address.postal_code","97217")
json.UpdateString("merchant_info.address.country_code","US")
json.UpdateString("billing_info[0].email","smith-buyer@chilkatsoft.com")
json.UpdateString("shipping_info.first_name","Sally")
json.UpdateString("shipping_info.last_name","Patient")
json.UpdateString("shipping_info.business_name","Not applicable")
json.UpdateString("shipping_info.phone.country_code","001")
json.UpdateString("shipping_info.phone.national_number","5039871234")
json.UpdateString("shipping_info.address.line1","1234 Broad St.")
json.UpdateString("shipping_info.address.city","Portland")
json.UpdateString("shipping_info.address.state","OR")
json.UpdateString("shipping_info.address.postal_code","97216")
json.UpdateString("shipping_info.address.country_code","US")
json.UpdateString("items[0].name","Sutures")
# We are updating the quantity from 100.0 to 200.0
# Note: The UpdateNumber method is added in v9.5.0.65
json.UpdateNumber("items[0].quantity","200.0")
json.UpdateString("items[0].unit_price.currency","USD")
json.UpdateString("items[0].unit_price.value","5.00")
json.UpdateString("payment_term.term_type","NET_45")
json.UpdateString("payment_term.due_date","2016-12-30 PST")
json.UpdateString("note","Medical Invoice 16 Jul, 2013 PST")
# The JSON created by the above code is this:
# {
# "merchant_info": {
# "email": "smith-facilitator@chilkatsoft.com",
# "first_name": "Joe",
# "last_name": "Facilitator",
# "business_name": "Medical Professionals, LLC",
# "phone": {
# "country_code": "001",
# "national_number": "5032141716"
# },
# "address": {
# "line1": "1234 Main St.",
# "city": "Portland",
# "state": "OR",
# "postal_code": "97217",
# "country_code": "US"
# }
# },
# "billing_info": [
# {
# "email": "smith-buyer@chilkatsoft.com"
# }
# ],
# "shipping_info": {
# "first_name": "Sally",
# "last_name": "Patient",
# "business_name": "Not applicable",
# "phone": {
# "country_code": "001",
# "national_number": "5039871234"
# },
# "address": {
# "line1": "1234 Broad St.",
# "city": "Portland",
# "state": "OR",
# "postal_code": "97216",
# "country_code": "US"
# }
# },
# "items": [
# {
# "name": "Sutures",
# "quantity": 200.0,
# "unit_price": {
# "currency": "USD",
# "value": "5.00"
# }
# }
# ],
# "payment_term": {
# "term_type": "NET_45",
# "due_date": "2016-12-30 PST"
# },
# "note": "Medical Invoice 16 Jul, 2013 PST"
# }
rest.AddHeader("Authorization",sbAuth.getAsString())
rest.AddHeader("Content-Type","application/json")
invoiceId = "INV2-XV4B-736P-PLVN-SZCE"
sbPath = chilkat.CkStringBuilder()
sbPath.Append("/v1/invoicing/invoices/")
sbPath.Append(invoiceId)
# Send the PUT request containign the JSON in the request body, and get the JSON response.
sbJsonRequest = chilkat.CkStringBuilder()
json.EmitSb(sbJsonRequest)
sbJsonResponse = chilkat.CkStringBuilder()
success = rest.FullRequestSb("PUT",sbPath.getAsString(),sbJsonRequest,sbJsonResponse)
if (success != True):
print(rest.lastErrorText())
sys.exit()
json.LoadSb(sbJsonResponse)
print("Response Status Code = " + str(rest.get_ResponseStatusCode()))
# Did we get a 200 success response?
if (rest.get_ResponseStatusCode() != 200):
print(json.emit())
print("Failed.")
sys.exit()
# Sample response JSON is shown below.
# Get some information..
print("email: " + json.stringOf("merchant_info.email"))
print("business_name: " + json.stringOf("merchant_info.business_name"))
numItems = json.SizeOfArray("items")
i = 0
while i < numItems :
json.put_I(i)
print("item name: " + json.stringOf("items[i].name"))
print("item quantity: " + json.stringOf("items[i].quantity"))
print("item currency: " + json.stringOf("items[i].unit_price.currency"))
print("item value: " + json.stringOf("items[i].unit_price.value"))
print("----")
i = i + 1
print("Success.")