Python Requires Chilkat v11.0.0+

PayPal: List merchant invoices across pages

See more PayPal Examples

List invoices for the authenticated merchant. Request totals, iterate every page, and keep the PayPal ID alongside the human-readable number and current status.

PayPal documentation

Python

import sys
import chilkat2

success = False

# See Unlock Chilkat before making requests.
# For the merchant's internal backoffice application. Load the sandbox token
# from the merchant's credential store. Keep it out of publicly distributed apps.
# See Get a PayPal access token.
http = chilkat2.Http()
http.AuthToken = "SANDBOX_ACCESS_TOKEN"
resp = chilkat2.HttpResponse()

# Request total_pages so a merchant with more than one page sees every invoice.
page = 1
lastPage = 1
while (page <= lastPage) :
    url = chilkat2.StringBuilder()
    url.Append("https://api-m.sandbox.paypal.com/v2/invoicing/invoices?total_required=true&page_size=20&page=")
    url.AppendInt(page)
    success = http.HttpNoBody("GET",url.GetAsString(),resp)
    if (success != True):
        print("No HTTP response: " + http.LastErrorText)
        sys.exit()

    if ((resp.StatusCode < 200) or (resp.StatusCode >= 300)):
        errorInfo = chilkat2.JsonObject()
        errorInfo.Load(resp.BodyStr)
        print("HTTP " + str(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"))
        print("PayPal debug ID: " + errorInfo.StringOf("debug_id"))
        sys.exit()

    result = chilkat2.JsonObject()
    parsed = result.Load(resp.BodyStr)
    if (parsed != True):
        print("Expected a JSON response; HTTP " + str(resp.StatusCode))
        sys.exit()

    i = 0
    count = result.SizeOfArray("items")
    while (i < count) :
        result.I = i
        print(result.StringOf("items[i].id") + "  " + result.StringOf("items[i].detail.invoice_number") + "  " + result.StringOf("items[i].status"))
        i = i + 1

    lastPage = result.IntOf("total_pages")
    page = page + 1