Overview
The Zoho Commerce integration provides a set of ready-made functions you can call when building mappings. They handle common lookups and conversions between your iPaaS.com data and Zoho Commerce, such as resolving a category or location ID and finding a product's variant, so you do not have to write that logic yourself in a formula.
Where you can use these functions
These functions are available anywhere you write a formula for the Zoho Commerce integration:
Dynamic Formula mappings: where a destination field's value is produced by a formula rather than mapped directly from a source field.
Mapping collection filters: where a formula decides whether a record should be processed.
Error filters: a mapping collection's error filter, which sits alongside its collection filter. When the error filter's formula resolves to true, the transfer raises an error that is held in the Error Logs for review and is not retried automatically.
Translation collections: where a translation entry uses a formula as its source value.
How to use them
Call a function by name and pass the values it needs in parentheses, for example:
await ConvertCategoriesToZohoCommerceId(SourceCategories).Each function's signature shows its name, the parameters it accepts (with their types), and the type of value it returns. Use it as the reference for exactly how to call the function.
Function names and formula syntax are case-sensitive, so type each name exactly as shown. Whether the values a function matches are treated as case-sensitive varies by function, and is called out in the relevant parameter's description.
Every function that returns a
Taskis asynchronous and must be called withawait, as shown in each How to call it example.Each function runs at sync time, against the data in your connected Zoho Commerce account and your iPaaS.com subscription.
The functions are grouped below by the area of the integration they support.
Categories
ConvertCategoriesToZohoCommerceId
What it does: Takes a set of iPaaS.com categories and returns the Zoho Commerce category ID of the first one whose name matches an existing Zoho Commerce category.
Signature: Task<string> ConvertCategoriesToZohoCommerceId(object categories)
How to call it: await ConvertCategoriesToZohoCommerceId(categories)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The iPaaS.com categories to match, each carrying a category name that is compared against Zoho Commerce category names. |
Returns: string. The Zoho Commerce category ID of the first matching category, or an empty string if none match.
Example: [{"CategoryName": "Electronics"}, {"CategoryName": "Furniture"}] returns the Zoho Commerce category ID of the first one found.
When to use it: Use this in the product flow to assign a Zoho Commerce category to a product based on the product's iPaaS.com categories.
Products
GetVariantIdByProductId
What it does: Looks up a Zoho Commerce product by its ID and returns the ID of its first variant.
Signature: Task<string> GetVariantIdByProductId(object productId)
How to call it: await GetVariantIdByProductId(productId)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The Zoho Commerce product ID to look up, typically a string. |
Returns: string. The first variant's Zoho Commerce variant ID, or null if the product is not found or has no variants.
Example: "abc123" returns the variant ID of the first variant on that Zoho Commerce product.
When to use it: Use this when a mapping needs a Zoho Commerce variant ID and you have only the product ID.
Locations
ConvertiPaaSLocationIdToCommerceId
What it does: Maps an iPaaS.com location ID to the linked Zoho Commerce location ID.
Signature: Task<string> ConvertiPaaSLocationIdToCommerceId(object locationId)
How to call it: await ConvertiPaaSLocationIdToCommerceId(locationId)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The iPaaS.com location ID to map, typically a string or numeric identifier. |
Returns: string. The Zoho Commerce location ID linked to the iPaaS.com location ID. If the lookup fails, the function raises an error.
Example: "12345" returns the Zoho Commerce location ID mapped from that iPaaS.com location.
When to use it: Use this when inventory data references an iPaaS.com location and a Zoho Commerce field needs the matching Zoho Commerce location ID.