Overview
The ShipStation integration provides a ready-made function you can call when building mappings. It maps an iPaaS.com location to the matching ShipStation location, so you do not have to write that lookup yourself in a formula.
Where you can use these functions
These functions are available anywhere you write a formula for the ShipStation 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 ConvertiPaaSLocationIdToCommerceId(SourceLocationId).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.The function runs at sync time, against the data in your connected ShipStation account and your iPaaS.com subscription.
The functions are grouped below by the area of the integration they support.
Locations
ConvertiPaaSLocationIdToCommerceId
What it does: Maps an iPaaS.com location ID to the linked ShipStation 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 ShipStation location ID linked to the iPaaS.com location ID. If the lookup fails, the function raises an error.
Example: 2001 returns the ShipStation 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 ShipStation location ID.