Zoho CRM Custom icon

Zoho CRM Custom

Consume Zoho CRM API

Overview

The "Zoho CRM Custom" node for n8n allows you to create or update (upsert) Sales Orders in Zoho CRM. This operation is useful when you want to either add a new sales order or update an existing one based on the provided subject. The node collects detailed information about the sales order, including account, products, billing/shipping addresses, and various financial fields.

Common scenarios:

  • Automating the creation of sales orders from e-commerce transactions.
  • Syncing sales order data between Zoho CRM and other business systems.
  • Updating existing sales orders with new product or customer details.

Practical example:
When a new order is placed in your online store, this node can automatically create a corresponding sales order in Zoho CRM, including all relevant product and customer information. If an order with the same subject already exists, it will be updated instead.


Properties

Name Type Meaning
Account Name or ID options Select or specify the account associated with the sales order. Required.
Subject string Title or subject of the sales order. Used to identify if an existing record should be updated or a new one created. Required.
Products collection List of products included in the sales order. Each product entry can include price, quantity, description, tax, totals, etc.
Additional Fields collection Optional extra fields for the sales order, such as adjustment, addresses, carrier, contact, currency, custom fields, deal, description, discount, due date, exchange rate, status, subtotal, tax, terms, etc.

Products sub-fields:

  • List Price (number): Price per unit before discounts/taxes.
  • Product Name or ID (options): Select or specify the product.
  • Product Description (string): Description of the product.
  • Quantity (number): Number of units ordered.
  • Quantity in Stock (number): Current stock level.
  • Tax (number): Tax amount for the product.
  • Total (number): Total price for the product line.
  • Total After Discount (number): Line total after discounts.
  • Total (Net) (number): Net total for the product.
  • Unit Price (number): Final price per unit.

Additional Fields highlights:

  • Adjustment (number): Any adjustment to the grand total.
  • Billing Address / Shipping Address (fixedCollection): Structured address fields.
  • Carrier (string): Name of the shipping carrier.
  • Contact Name or ID (options): Associated contact.
  • Currency (options): Currency symbol (e.g., USD, EUR).
  • Custom Fields (fixedCollection): Set custom field values.
  • Deal Name or ID (options): Link to a related deal.
  • Description (string): Free-text description.
  • Discount (number): Discount percentage.
  • Due Date (dateTime): When payment is due.
  • Exchange Rate (number): Currency exchange rate.
  • Grand Total (number): Final total after taxes/discounts.
  • Sales Order Number (string): Reference number for the order.
  • Sales Commission (number): Commission percentage.
  • Status Name or ID (options): Status of the sales order.
  • Sub Total (number): Total before taxes.
  • Tax (number): Total tax amount.
  • Terms and Conditions (string): Purchase terms.

Output

The node returns the details of the created or updated sales order as a JSON object. The structure typically includes:

{
  "id": "unique_sales_order_id",
  "Account_Name": { "id": "account_id", ... },
  "Subject": "Order subject",
  "Product_Details": [
    {
      "product": "Product Name",
      "quantity": 2,
      "list_price": 100,
      ...
    }
  ],
  // ...other fields as set in input properties
}
  • All fields sent in the request (including additional/custom fields) are reflected in the output, along with system-generated fields like id, timestamps, etc.
  • If the operation fails and "Continue On Fail" is enabled, the output will contain an error property with the error message.

Dependencies

  • External Service: Requires access to Zoho CRM API.
  • Authentication: Needs valid Zoho OAuth2 credentials configured in n8n (zohoOAuth2Api).
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common issues:

  • Missing required fields: If required fields like "Account Name or ID" or "Subject" are not provided, the node will throw an error.
  • Invalid IDs: Supplying an incorrect Account, Product, or Contact ID will result in an API error from Zoho.
  • No products specified: At least one product must be included; otherwise, the node will fail.
  • Field value errors: Invalid data types (e.g., text in a number field) will cause validation errors.

Error messages:

  • "Required field missing": Ensure all mandatory fields are filled.
  • "Invalid ID": Double-check that referenced records exist in Zoho CRM.
  • "No products specified": Add at least one product to the sales order.
  • "API authentication failed": Verify Zoho OAuth2 credentials in n8n.

Links and References

Discussion