Tcl
Tcl
PayPal Search for Invoices
See more PayPal Examples
Search PayPal invoices.See also SearchInvoices
Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# Note: Requires Chilkat v9.5.0.64 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)
set jsonToken [new_CkJsonObject]
CkJsonObject_LoadFile $jsonToken "qa_data/tokens/paypal.json"
# Build the Authorization request header field value.
set sbAuth [new_CkStringBuilder]
# token_type should be "Bearer"
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "token_type"]
CkStringBuilder_Append $sbAuth " "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "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.
set rest [new_CkRest]
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.sandbox.paypal.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
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..
# ----------------------------------------------------------------------------------------------
# Create JSON to specify the search
set json [new_CkJsonObject]
CkJsonObject_put_EmitCompact $json 0
CkJsonObject_AppendString $json "start_invoice_date" "2016-01-01 PST"
CkJsonObject_AppendString $json "end_invoice_date" "2016-11-16 PST"
CkJsonObject_AppendInt $json "page" 0
CkJsonObject_AppendInt $json "page_size" 10
CkJsonObject_AppendBool $json "total_count_required" 1
puts [CkJsonObject_emit $json]
# The JSON by the above code:
# {
# "start_invoice_date": "2016-01-01 PST",
# "end_invoice_date": "2016-11-16 PST",
# "page": 0,
# "page_size": 10,
# "total_count_required": true
# }
# Send the POST equivalent to this CURL command:
# curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
# -H "Content-Type:application/json" \
# -H "Authorization: Bearer Access-Token" \
# -d '{ invoice JSON goes here }'
CkJsonObject_put_EmitCompact $json 1
set sbRequestBody [new_CkStringBuilder]
set sbResponseBody [new_CkStringBuilder]
CkRest_AddHeader $rest "Content-Type" "application/json"
CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]
CkJsonObject_EmitSb $json $sbRequestBody
set success [CkRest_FullRequestSb $rest "POST" "/v1/invoicing/search" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
# We should have some sort of JSON response. It could be successful, or an error.
set jsonResponse [new_CkJsonObject]
CkJsonObject_put_EmitCompact $jsonResponse 0
CkJsonObject_LoadSb $jsonResponse $sbResponseBody
puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"
# Did we get a 200 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
# Show the JSON response body
puts [CkJsonObject_emit $jsonResponse]
puts "Failed."
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse
exit
}
# Sample response JSON is shown below.
# Iterate over each invoice and get some information from each..
set numInvoices [CkJsonObject_SizeOfArray $jsonResponse "invoices"]
set i 0
while {$i < $numInvoices} {
CkJsonObject_put_I $jsonResponse $i
puts "Invoice ID: [CkJsonObject_stringOf $jsonResponse {invoices[i].id}]"
puts "Shipping First Name: [CkJsonObject_stringOf $jsonResponse {invoices[i].shipping_info.first_name}]"
set j 0
set numBillingInfo [CkJsonObject_SizeOfArray $jsonResponse "invoices[i].billing_info"]
while {$j < $numBillingInfo} {
CkJsonObject_put_J $jsonResponse $j
puts "billing_info email: [CkJsonObject_stringOf $jsonResponse {invoices[i].billing_info[j].email}]"
set j [expr $j + 1]
}
set numLinks [CkJsonObject_SizeOfArray $jsonResponse "invoices[i].links"]
set j 0
while {$j < $numLinks} {
CkJsonObject_put_J $jsonResponse $j
puts "link: [CkJsonObject_stringOf $jsonResponse {invoices[i].links[j].href}]"
set j [expr $j + 1]
}
puts "----"
set i [expr $i + 1]
}
puts "Success."
# A successful response looks like this:
# {
# "total_count": 2,
# "invoices": [
# {
# "id": "INV2-XV4B-736P-PLVN-SZCE",
# "number": "0002",
# "status": "DRAFT",
# "merchant_info": {
# "email": "smith-facilitator@chilkatsoft.com"
# },
# "billing_info": [
# {
# "email": "smith-buyer@chilkatsoft.com"
# }
# ],
# "shipping_info": {
# "email": "smith-buyer@chilkatsoft.com",
# "first_name": "Sally",
# "last_name": "Patient",
# "business_name": "Not applicable"
# },
# "invoice_date": "2016-11-15 PST",
# "payment_term": {
# "due_date": "2016-12-30 PST"
# },
# "note": "Medical Invoice 16 Jul, 2013 PST",
# "total_amount": {
# "currency": "USD",
# "value": "500.00"
# },
# "metadata": {
# "created_date": "2016-11-15 08:09:21 PST"
# },
# "paid_amount": {
# "paypal": {
# "currency": "USD",
# "value": "0.00"
# },
# "other": {
# "currency": "USD",
# "value": "0.00"
# }
# },
# "refunded_amount": {
# "paypal": {
# "currency": "USD",
# "value": "0.00"
# },
# "other": {
# "currency": "USD",
# "value": "0.00"
# }
# },
# "links": [
# {
# "rel": "self",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
# "method": "GET"
# },
# {
# "rel": "send",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
# "method": "POST"
# },
# {
# "rel": "update",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
# "method": "PUT"
# },
# {
# "rel": "delete",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
# "method": "DELETE"
# }
# ]
# },
# {
# "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
# "number": "0001",
# "status": "SENT",
# "merchant_info": {
# "email": "smith-facilitator@chilkatsoft.com"
# },
# "billing_info": [
# {
# "email": "smith-buyer@chilkatsoft.com"
# }
# ],
# "shipping_info": {
# "email": "smith-buyer@chilkatsoft.com",
# "first_name": "Sally",
# "last_name": "Patient",
# "business_name": "Not applicable"
# },
# "invoice_date": "2016-11-15 PST",
# "payment_term": {
# "due_date": "2016-12-30 PST"
# },
# "note": "Medical Invoice 16 Jul, 2013 PST",
# "total_amount": {
# "currency": "USD",
# "value": "500.00"
# },
# "metadata": {
# "created_date": "2016-11-15 06:17:03 PST",
# "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
# },
# "paid_amount": {
# "paypal": {
# "currency": "USD",
# "value": "0.00"
# },
# "other": {
# "currency": "USD",
# "value": "0.00"
# }
# },
# "refunded_amount": {
# "paypal": {
# "currency": "USD",
# "value": "0.00"
# },
# "other": {
# "currency": "USD",
# "value": "0.00"
# }
# },
# "links": [
# {
# "rel": "self",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
# "method": "GET"
# },
# {
# "rel": "update",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
# "method": "PUT"
# },
# {
# "rel": "cancel",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
# "method": "POST"
# },
# {
# "rel": "remind",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
# "method": "POST"
# },
# {
# "rel": "record-payment",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
# "method": "POST"
# },
# {
# "rel": "qr-code",
# "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
# "method": "GET"
# }
# ]
# }
# ]
# }
#
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse