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: Update, this node updates an existing sales order in your Zoho CRM account using the provided fields.

Common scenarios:

  • Automating updates to sales orders based on changes in other systems (e.g., ERP, e-commerce platforms).
  • Bulk updating sales order details such as status, billing/shipping addresses, or custom fields.
  • Integrating Zoho CRM with other business tools to keep sales order information synchronized.

Practical example:
If a customer changes their shipping address after placing an order, you can use this node to update the corresponding sales order in Zoho CRM automatically.


Properties

Name Type Meaning
Sales Order ID String ID of the sales order to update. This identifies which sales order record will be modified.
Update Fields Collection A group of fields specifying what data to update on the sales order. See below for available sub-fields.

Update Fields (sub-fields):

Name Type Meaning
Account Name or ID Options The account associated with the sales order. Select from list or specify an ID/expression.
Adjustment Number Adjustment amount in the grand total, if any.
Billing Address Fixed Collection Billing address details (Street, City, State, Country, Zip Code).
Carrier String Name of the carrier handling the order shipment.
Contact Name or ID Options Associated contact. Select from list or specify an ID/expression.
Currency Options Currency symbol for the sales order (e.g., USD, EUR, INR, etc.).
Custom Fields Fixed Collection Set values for custom fields defined in your Zoho CRM sales order module.
Deal Name or ID Options Associated deal. Select from list or specify an ID/expression.
Description String Description or notes about the sales order.
Discount Number Discount applied to the sales order.
Due Date DateTime Due date for the sales order.
Exchange Rate Number Exchange rate between default and home currency.
Grand Total Number Total amount after tax and discounts.
Sales Order Number String Identifier for the sales order (after case creation).
Sales Commission Number Salesperson's commission percentage for this order.
Shipping Address Fixed Collection Shipping address details (Street, City, State, Country, Zip Code).
Status Name or ID Options Status of the sales order. Select from list or specify an ID/expression.
Sub Total Number Total amount before tax.
Subject String Title or subject of the sales order.
Tax Number Total tax amount (sales tax + VAT).
Terms and Conditions String Terms and conditions related to the sales order.

Output

  • The output is a JSON object representing the updated sales order details as returned by the Zoho CRM API.
  • The structure typically includes all standard and custom fields of the sales order, reflecting the latest state after the update.
  • Example output (structure may vary depending on your Zoho CRM setup):
{
  "id": "1234567890",
  "Account_Name": {
    "id": "987654321",
    "name": "Acme Corp"
  },
  "Subject": "Updated Sales Order",
  "Status": "Delivered",
  "Billing_Address": {
    "Billing_Street": "123 Main St",
    "Billing_City": "Metropolis",
    ...
  },
  "Shipping_Address": {
    "Shipping_Street": "456 Side St",
    ...
  },
  "Grand_Total": 1500,
  "custom_field_1": "Value",
  ...
}
  • If the update fails and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

  • Zoho CRM account with appropriate permissions to update sales orders.
  • Zoho OAuth2 API credentials must be set up in n8n under the name zohoOAuth2Api.
  • No additional environment variables are required beyond standard n8n credential configuration.

Troubleshooting

Common issues:

  • Missing or invalid Sales Order ID:

    • Error: "Sales Order ID is required" or similar.
      Resolution: Ensure you provide a valid Sales Order ID that exists in Zoho CRM.
  • No fields to update:

    • Error: "At least one field must be specified for update" or similar.
      Resolution: Make sure at least one field is set in "Update Fields".
  • Invalid field values:

    • Error: "Invalid value for field X"
      Resolution: Double-check the data types and allowed values for each field, especially for options and custom fields.
  • Authentication errors:

    • Error: "Invalid credentials" or "Unauthorized"
      Resolution: Verify that your Zoho OAuth2 credentials are correctly configured and have not expired.

Links and References

Discussion