How to List All Sales Orders in Zoho Inventory with Pagination

How to List All Sales Orders in Zoho Inventory with Pagination

Introduction:

While working with the Zoho Inventory API, I encountered the limitation of retrieving only 200 records per API call. To overcome this, I implemented pagination by tweaking a solution initially built for Zoho CRM. Below is the solution I used to fetch all sales orders, which can be adapted for other modules (Invoices, Packages, etc.).

Problem:

The Zoho Inventory API has a limit of 200 records per API call, which makes it challenging to retrieve a large dataset like all sales orders. This script helps by implementing pagination and recursively fetching data page by page.

Solution:

Here is the code I used. It loops through a list of page numbers and accumulates all records until no further pages are available:

  2. // *******
  3. // Zoho Inventory API Pagination for Listing All Sales Orders
  4. // *******

  6. // CONFIG: Organization ID
  7. organizationId = "*****";
  8. // CONFIG: Name of Zoho Inventory module (SalesOrders, Packages, Invoices, etc.)
  9. zohoInventoryModule = "salesorders";
  10. // CONFIG: Number of results to return per page. DO NOT exceed the per_page limit of your API, or this function will not perform correctly.
  11. perPageLimit = 200;

  13. // List of page numbers. This should start with '1' and be much longer than the expected number of pages.
  14. pageIterationList = {1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25};

  16. // List to accumulate all records
  17. allRecords = List();

  19. // The 'while' condition for evaluation. While this is 'false', the API requests will continue. 
  20. iterationComplete = false;

  22. // Loop over each page in the page list
  23. for each page in pageIterationList
  24. {
  25.     // Evaluate whether 'while' condition is satisfied
  26.     if(iterationComplete == false)
  27.     {
  28.         // CONFIG: Set the param for OrganizationId if user is set in multiple Organizations
  29.         params = Map();
  30.         params.put("organization_id",organizationId);
  31.         
  32.         // Get records from Zoho Inventory API.
  33.         // CONFIG: Name of Zoho Inventory API Connection
  34.         response = invokeurl
  35.         [
  36.             url :"https://www.zohoapis.eu/inventory/v1/" + zohoInventoryModule + "?page=" + page + "&per_page=" + perPageLimit
  37.             type :GET
  38.             parameters:params
  39.             connection:"zohoinventoryfullcon"
  40.         ];

  42.         // Get records from API response. Add them to allRecords list.
  43.         records = response.get("salesorders");
  44.         allRecords.addAll(records);

  46.         // Update 'while' condition status
  47.         if(response.get("page_context").get("has_more_page") == false)
  48.         {
  49.             iterationComplete = true;
  50.         }
  51.     }
  52. }

  54. // Check for correctness
  55. info "Number of Records: " + allRecords.size();