Overview
The Zuper 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 Zuper, such as resolving a category or location ID and wrapping a list of product serial numbers, 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 Zuper 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 ConvertCategoryToZuperId(SourceCategory).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.
Some of these functions are asynchronous (their signature returns a
Task) and must be called withawait; the rest are synchronous and are called directly. Each function's How to call it example shows the correct form.Each function runs at sync time, against the data in your connected Zuper account and your iPaaS.com subscription.
The functions are grouped below by the area of the integration they support.
Categories
ConvertCategoryToZuperId
What it does: Looks up a category by name in Zuper and returns its Zuper category ID. Only categories that already exist in Zuper are matched.
Signature: Task<string> ConvertCategoryToZuperId(string category)
How to call it: await ConvertCategoryToZuperId(category)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The category name to look up. It must exactly match an existing Zuper category name. |
Returns: string. The Zuper category ID for the matching category, or an empty string if the category is not found in Zuper.
Example: "Electronics" returns the Zuper category ID when a category named Electronics exists in Zuper.
When to use it: Use this when a mapping has a single category name and a Zuper field needs the matching Zuper category ID.
ConvertCategoriesToZuperId
What it does: Takes a set of iPaaS.com categories and returns the Zuper category ID of the first one that matches an existing Zuper category.
Signature: Task<string> ConvertCategoriesToZuperId(object categories)
How to call it: await ConvertCategoriesToZuperId(categories)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The iPaaS.com categories to match. Each entry's category name must match an existing Zuper category name. |
Returns: string. The Zuper category ID of the first category that matches an existing Zuper category, or an empty string if none match.
Example: A list containing Electronics and Appliances returns the Zuper category ID of the first one found in Zuper.
When to use it: Use this when a product has several iPaaS.com categories and a Zuper field needs a single matching Zuper category ID.
Products
UpdateProductSerialNumbers
What it does: Wraps a list of product serial numbers in the object shape Zuper expects.
Signature: serialNoObject UpdateProductSerialNumbers(List<string> serialNos)
How to call it: UpdateProductSerialNumbers(serialNos)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The product serial numbers to wrap. |
Returns: serialNoObject. An object containing the supplied serial numbers.
Example: ["SN12345", "SN67890"] returns an object holding those two serial numbers.
When to use it: Use this when a Zuper product mapping needs its serial numbers in the wrapped object form rather than as a plain list.
Locations
ConvertiPaaSLocationIdToZuperId
What it does: Maps an iPaaS.com location ID to the linked Zuper location ID.
Signature: Task<string> ConvertiPaaSLocationIdToZuperId(object locationId)
How to call it: await ConvertiPaaSLocationIdToZuperId(locationId)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The iPaaS.com location ID to map, typically a string. The location must already exist in Zuper. |
Returns: string. The Zuper location ID linked to the iPaaS.com location ID, or an empty string if no mapping is found.
Example: "LOC-12345" returns the Zuper location ID mapped from that iPaaS.com location.
When to use it: Use this when a mapping references a location by its iPaaS.com ID and you need the matching Zuper location ID.