Zoho CRM Custom icon

Zoho CRM Custom

Consume Zoho CRM API

Overview

The Zoho CRM Custom node for n8n allows you to interact with the Zoho CRM API. Specifically, when configured with the Resource: Sales Order and Operation: Get Many (also known as "getAll"), this node retrieves multiple sales order records from your Zoho CRM account.

This operation is useful in scenarios where you need to:

  • List all or a filtered set of sales orders for reporting, analytics, or integration with other systems.
  • Retrieve only approved, converted, or territory-specific sales orders.
  • Limit the number of results or fetch all available records.
  • Select specific fields to optimize data transfer and processing.

Practical examples:

  • Fetching all approved sales orders for a monthly report.
  • Integrating sales order data into an ERP or accounting system.
  • Building dashboards that display recent or high-value sales orders.

Properties

Name Type Meaning
Return All Boolean Whether to return all results or only up to a given limit. If false, the "Limit" property applies.
Limit Number Maximum number of results to return. Only shown if "Return All" is false.
Options Collection Additional filters and settings for retrieving sales orders.
└ Approved Boolean Whether to retrieve only approved records. Defaults to true.
└ Converted Boolean Whether to retrieve only converted records. Defaults to false.
└ Fields MultiOptions Specify which fields to include in the response.
└ Include Child Boolean Whether to retrieve only records from child territories.
└ Sort By Options Field to sort records by.
└ Sort Order Options Ascending or descending sort order ("asc" or "desc").
└ Territory ID String Retrieve only records from this territory.

Output

  • The output is an array of JSON objects, each representing a sales order record from Zoho CRM.
  • The structure of each object depends on the selected fields and options, but typically includes standard sales order properties such as IDs, subject, status, account information, product details, etc.
  • If the "Fields" option is used, only those fields will be present in each output object.

Example output:

[
  {
    "id": "1234567890",
    "Subject": "Order #1001",
    "Status": "Approved",
    "Account_Name": {
      "id": "0987654321",
      "name": "Acme Corp"
    },
    "Total": 1500,
    ...
  },
  ...
]

Note: The actual fields depend on your selection and Zoho CRM configuration.


Dependencies

  • Zoho CRM Account: You must have access to a Zoho CRM account.
  • API Credentials: Requires OAuth2 credentials (zohoOAuth2Api) configured in n8n.
  • n8n Configuration: Ensure the Zoho CRM node is properly authorized via OAuth2 in your n8n instance.

Troubleshooting

Common Issues:

  • Authentication Errors: If credentials are missing or expired, the node will fail to connect to Zoho CRM. Re-authenticate in n8n's credentials section.
  • Insufficient Permissions: The connected Zoho user must have permission to read sales orders.
  • Field Selection Errors: Specifying non-existent or restricted fields in the "Fields" option may result in errors or empty responses.
  • API Limits: Zoho CRM may enforce rate limits; excessive requests could lead to temporary blocking.

Error Messages & Resolutions:

  • "Invalid OAuth token": Refresh or reauthorize your Zoho CRM credentials in n8n.
  • "Permission denied": Check the Zoho CRM user's permissions for accessing sales orders.
  • "Invalid field name": Review the "Fields" option and ensure all specified fields exist in your Zoho CRM module.

Links and References

Discussion