Add/Update Jasper PIM Product Category FROM iPaaS.com Mapping Documentation

This integration transfers product category records from iPaaS.com into Jasper PIM, creating or updating a single Jasper PIM category for each iPaaS Product Category that is synced. Each transfer sends the category's display name, optional description, parent linkage, and storefront-visibility flag, populating and maintaining the Jasper PIM catalog tree so that products synced through the Add/Update Jasper PIM Product FROM iPaaS.com collection can be correctly categorized on Jasper PIM storefronts. The iPaaS category hierarchy is preserved in Jasper PIM by translating each iPaaS parent reference into the corresponding Jasper PIM category at transfer time.

Mapping Collection Status

Add/Update Jasper PIM Product Category FROM iPaaS.com — Enabled. The collection runs whenever it is dispatched by Manual Sync or by an outbound trigger event. A row-level mapping filter is in place that enforces parent-before-child ordering on a per-row basis; this filter does not disable the collection, it only rejects rows whose parent has not yet been transferred. See Cross-collection Dependencies below for full filter behavior.
Trigger Events: Create (Add Product Category) and Update (Update Product Category), via the iPaaS.com outbound trigger subscriptions described under Setup Requirements.

ID Format

Manual Sync ID Format

On the iPaaS.com Manual Sync page, enter the iPaaS Product Category ID — the iPaaS-side identifier of the category record you want to transfer. Example value: 12345.

External ID Format

After a successful transfer, iPaaS.com records the new Jasper PIM category ID as the external ID on a dedicated external-ID record for the Product Category mapping collection type, scoped to this Jasper PIM connection. Subsequent transfers of the same iPaaS Product Category route to a Jasper PIM update via that external-ID record rather than creating a duplicate category in Jasper PIM. Because the external ID is scoped to the Jasper PIM connection, IDs recorded for other connected external systems are not used as a match by mistake.

Supported Child Collections

This collection has no child collections. The product-to-category linkage is established by the Add/Update Jasper PIM Product FROM iPaaS.com collection at the time products are transferred, not by a child collection underneath Product Category.

Setup Requirements

Authentication and Security

Jasper PIM — Requires an API key generated in the Jasper PIM admin console with read and write permissions on Product Categories. The key is stored on the Jasper PIM connection in iPaaS.com.
iPaaS.com — Requires the standard iPaaS.com connection credentials with permission to dispatch the Add Product Category and Update Product Category outbound triggers, and to use the iPaaS.com external-ID lookup service used by the parent-reference mapping.

Full credential setup is documented in the Jasper PIM Installation Instructions article (published separately).

Transfer Methods

Manual Sync. Subscribers can transfer a single category at any time from the iPaaS.com Manual Sync page by entering the iPaaS Product Category ID. This is the recommended way to verify the configuration, to backfill specific records, or to re-run a category that previously failed.
Automatic (Outbound Triggers). Subscribers enable automatic transfers in the subscription configuration's Outbound Data Flows section by subscribing the Add Product Category and Update Product Category outbound triggers to dispatch this mapping collection. Until those subscriptions are enabled, no automatic transfers will occur — there is no scheduler or polling component for this collection.
Bulk / Initial Load. Jasper PIM does not support initial-load (bulk pull) of product categories through this integration. To seed an existing iPaaS catalog into a new Jasper PIM tenant, follow the canonical bulk sync using Postman workaround, iterating over iPaaS Product Category IDs in parent-before-child order.

Jasper PIM Prerequisites

A Jasper PIM tenant with the Product Categories API enabled and an API key configured with read and write permissions on categories.
A target catalog in Jasper PIM ready to receive categories. If the tenant already contains categories that were not created through iPaaS.com, see the Known Caveats and Limitations section for guidance — this collection does not auto-match pre-existing Jasper PIM categories on first sync.

Integration Flow

A transfer is initiated either by the subscriber via Manual Sync (entering an iPaaS Product Category ID) or automatically by the Add Product Category or Update Product Category outbound trigger event subscribed in Outbound Data Flows.
iPaaS.com loads the source Product Category record and runs the mapping collection's row-level filter to verify parent ordering: the row is allowed through if the category has no parent (root category), or if the parent has already been transferred to Jasper PIM. If the parent has not yet been transferred, the row fails explicitly with the message "Parent category must be uploaded first."
For rows that pass the filter, iPaaS.com transforms the source fields into a Jasper PIM category payload — sending the category name and description directly, looking up the Jasper PIM ID of the parent category (when there is a parent) via the iPaaS.com external-ID service, and resolving the storefront-visibility flag.
iPaaS.com checks for an existing external-ID record linking this iPaaS Product Category to a Jasper PIM category. If one exists, the integration sends an update request to Jasper PIM for that category. If no external-ID record exists, the integration sends a create request and Jasper PIM returns a new category ID.
On a successful create, iPaaS.com records the new Jasper PIM category ID against the iPaaS Product Category as the external ID, so subsequent transfers route to an update rather than creating a duplicate.
If Jasper PIM rejects the request (for example, because the required Name field is empty), the failure surfaces in the iPaaS.com Error Logs for the subscription. Subscribers or their MiSP should review the failure message, correct the source record, and rerun the transfer.

Mappings

Add/Update Jasper PIM Product Category FROM iPaaS.com

Mapping Filter

var external = await GetExternalIdAsync(ParentId, "Product Category", SpaceportSystemId);
if(IsEmpty(ParentId))
    return true;
else if(!IsEmpty(ParentId) && IsEmpty(external))
    throw new Exception("Parent category must be uploaded first");
else
    return true;

Filter Description. This filter ensures that categories are only processed when their parent category requirements are satisfied. If ParentId is empty, the category is treated as a root category and allowed to proceed. If ParentId is provided but no matching Jasper PIM external ID exists yet, the filter throws an exception with the message "Parent category must be uploaded first" — the row fails explicitly rather than landing as an orphan at the root of the catalog tree. In all other cases where ParentId is valid and the parent's external ID is on file, the category is allowed to continue.

Mapping Type	Source Field (iPaaS.com)	Destination Field (Jasper PIM)	Description
Field	Product Category Name	Name	Required. The category's human-readable display name, shown in the Jasper PIM catalog tree and on storefronts where the category is rendered. Jasper PIM rejects the request if this value is empty; the connector does not substitute a default, so the rejection surfaces in iPaaS.com Error Logs.
Field	Product Category Description	Description	Optional. Free-form editorial copy displayed on the category page in Jasper PIM. The Jasper PIM Product Categories API accepts categories without a description and does not document a maximum length. If the source value is null or empty, no description is sent and Jasper PIM stores the category with an empty description.
Dynamic Formula	Looks up the Jasper PIM ID of the parent category from iPaaS.com's external-ID service, scoped to this Jasper PIM connection.	ParentId	Recommended (do not blank). Establishes the parent/child relationship in the Jasper PIM catalog tree by translating the iPaaS parent reference into the Jasper PIM internal category ID. When the source ParentId is empty, the row is allowed through by the collection-level filter (see Cross-collection Dependencies) and the ParentId field is omitted from the Jasper PIM request, so Jasper PIM creates the category at the root of its catalog tree. The default template's combination of this formula plus the collection-level filter correctly handles both root categories and orphan children — leave it wired as shipped.
Dynamic Formula	Derives a storefront-visibility boolean. The formula body is configured on the live mapping in the iPaaS.com UI; subscribers or their MiSP should consult the formula on their subscription to confirm exactly how visibility is derived.	IsVisible	Recommended. Controls whether the category is displayed on the Jasper PIM storefront — when true, the category appears in storefront navigation and search; when false, it is hidden from the storefront but still exists in the catalog and can hold products. Jasper PIM's documented default behavior when this field is omitted is not specified, so the template sends an explicit value to keep results predictable. The formula should always return a concrete true or false value rather than leaving the field empty.

Cross-collection Dependencies

Order of operations. Parent categories must be transferred before their children. The mapping collection's row-level filter enforces this on a per-row basis, so the catalog tree is always built top-down in Jasper PIM. There are three outcomes the filter can produce:

Root category (no parent in iPaaS). The row is allowed through and the category is created at the root of the Jasper PIM catalog tree. No subscriber configuration is required to make root categories work — the template handles this case directly.
Child category whose parent has already been transferred. The row is allowed through. The parent-lookup Dynamic Formula returns the Jasper PIM ID that was recorded on the parent's external-ID record, and the new or updated category is attached to that parent in Jasper PIM.
Child category whose parent has not yet been transferred. The row is rejected with the message "Parent category must be uploaded first." Orphan children therefore never silently land at the root of the Jasper PIM catalog tree — they fail explicitly until the parent is in place.

Subscriber action. Order Manual Sync runs from root downward, or — for automatic transfers — simply rerun any rows that failed with the "Parent category must be uploaded first" message after the missing parent has been synced. The integration does not automatically retry failed children when their parent later succeeds, so a rerun by the subscriber or their MiSP is required.

Downstream collections that depend on this one. Products synced through the Add/Update Jasper PIM Product FROM iPaaS.com collection rely on the Jasper PIM category tree being already populated when products reference categories. Subscribers planning a first-time load should transfer Product Category records ahead of Product records so that category references on products resolve cleanly.

Known Caveats and Limitations

Categories are created and updated, not deleted. Removing a category from iPaaS.com does not delete the corresponding category in Jasper PIM; the existing Jasper PIM category remains. Subscribers must remove obsolete categories in Jasper PIM directly.
No record-matching for pre-existing Jasper PIM categories. This collection does not auto-link to categories that already exist in Jasper PIM but were not created through iPaaS.com. On first sync of such a category, a new Jasper PIM category will be created and the original will remain unlinked. Subscribers seeding into a tenant that already contains categories should either start from an empty Jasper PIM catalog or manually align external-ID records before running transfers.
No bulk / initial-load support. Jasper PIM categories cannot be bulk-seeded through the iPaaS.com Sync page. Use the bulk sync using Postman workaround for first-time loads, iterating in parent-before-child order.
No polling or scheduled sync. Transfers occur only via Manual Sync or via outbound trigger events. Category changes in iPaaS.com that do not raise an outbound trigger event will not propagate to Jasper PIM automatically.
Orphan children fail until their parent is synced. This is by design (see Cross-collection Dependencies), but it means a transfer batch that includes children before their parents will produce explicit row-level failures the subscriber must rerun once the parents have completed.
Category name uniqueness is not documented by Jasper PIM. The Jasper PIM Product Categories API documentation does not state whether category names must be unique within a parent or across the catalog. Subscribers should still take care to avoid duplicate sibling category names so the Jasper PIM catalog tree remains easy to navigate for storefront merchandisers. If your source data is prone to producing duplicate sibling names, validate the behavior in a staging Jasper PIM tenant before relying on it in production.
Visibility default is undocumented. Jasper PIM's behavior when the visibility flag is omitted is not specified in the public API documentation. The default template sends an explicit value on every transfer to avoid relying on undocumented behavior.
Rate limiting and quotas. Jasper PIM does not publish a numeric rate-limit or per-period quota in its public API documentation; capacity is environment-dependent. The integration does not implement automatic rescheduling for rate-limit responses from Jasper PIM. To avoid timeouts and performance drops, subscribers or their MiSP should follow the published Jasper PIM operating guidance: stagger mass syncs, imports, and updates rather than running them concurrently; check the Jasper PIM Jobs Table before launching a batch action; and avoid running multiple intensive processes simultaneously.

External References

Jasper PIM API — Product Categories
Jasper PIM API — Products (for the downstream Add/Update Jasper PIM Product FROM iPaaS.com collection that links products to the categories created here)
Jasper PIM Knowledge Base — General Do's & Don'ts (operating guidance referenced under rate limiting and quotas)
Jasper PIM Knowledge Base — Understanding Inventory in Jasper (general Jasper PIM catalog operating background)
Jasper PIM Installation Instructions (subscriber configuration walkthrough; will be linkified during publishing)
Syncing a large dataset using iPaaS.com and Postman Runner (bulk / initial-load workaround)