Overview
This integration transfers iPaaS.com bulk pricing records to OroCommerce as Price Lists. When a bulk pricing record with an Applies To association is created or updated in iPaaS.com, the corresponding Price List and Product Prices are synchronized to OroCommerce, along with the associated customer group assignments.
Before You Begin
Ensure the following prerequisites are in place before configuring this integration.
OroCommerce Requirements
A valid OroCommerce account with administrator access.
Price List names must be unique; OroCommerce does not allow duplicates.
Product Prices must reference a Price List, unit, currency, product or variant, quantity, and value.
Only a single unit is supported per pricing record.
Price List currencies must include at least one valid currency.
Customer groups must exist in OroCommerce before being assigned to Price Lists.
Customer groups must be removed from Price Lists manually due to the global nature of OroCommerce Price Lists.
Bulk Pricing records require valid Product IDs. If the referenced product does not already exist in OroCommerce, the transfer will fail unless the Auto Create Product preset is enabled to automatically create and transfer the product.
Customer Category External IDs must exist and be correctly mapped to OroCommerce Customer Groups. If the customer group does not exist, the transfer will fail unless the Auto Create Customer Group preset is enabled to automatically create and transfer the customer group.
Custom fields require entity schema configuration. Serialized Field storage type is recommended.
iPaaS Requirements
Access to iPaaS.com with permissions to create and update Bulk Pricing records.
Bulk Pricing records must have valid Product External IDs, or the Auto Create Product preset must be enabled to automatically create and transfer the product when it does not already exist.
Customer Category External IDs must exist, or the Auto Create Customer Group preset must be enabled to automatically create and transfer the customer group when it does not already exist.
Currency and unit data must have corresponding external identifiers in OroCommerce.
OAuth 2.0 credentials must be correctly configured in iPaaS for OroCommerce API access.
ID Format
When manually transferring bulk pricing from iPaaS, enter the valid iPaaS bulk pricing ID (internal ID) into the iPaaS input field on the manual sync page. For example, use: 145146.
External ID Format: Bulk Pricing (Parent)
The iPaaS Bulk Pricing External ID consists of the OroCommerce Price List ID, Product Price ID, and Price List Customer Group IDs, all stored together as a single External ID. For example:
36|77159a94-a283-4988-91cc-fa843561d1a3-36|57|58|59
Where:
36— Price List ID77159a94-a283-4988-91cc-fa843561d1a3-36— Product Price ID57|58|59— Associated Price List Customer Group IDs
Deleted Record Support
This integration supports the removal of Product Prices when deleting Bulk Pricing from iPaaS, ensuring that stale prices do not remain in OroCommerce.
Note: Bulk Pricing delete mappings are included in the templates by default. Remove this mapping if you want to disable this functionality.
Custom Fields Support
This flow supports the use of custom fields. To map and add data from iPaaS.com into a custom field in OroCommerce, follow the steps outlined below.
Steps in OroCommerce
Log in to OroCommerce and click System > Entities > Entity Management.
Locate and select the module (entity) where you want to add the custom field (e.g., Product).
Click Create Field and configure all of the following required fields:
Field Name Provide a unique name. This value should start with a letter and contain only alphabetic symbols, underscores, and numbers.
Storage Type Select "Serialized field" or "Table Column".
For Table Column fields, a schema update is required before the custom field becomes available.
Serialized Field custom fields are added automatically and do not require a manual schema update.
Type Set field type as "string", "datetime", "integer", "float", "decimal", "boolean", or "enum" as they are all supported when using compatible mappings.
After creating the field with the Table Column storage type, a red Update Schema button will appear on the page. Click Update Schema to apply the changes.
NOTE: Contact your OroCommerce administrator before updating an entity schema to prevent unexpected service downtime.Once the schema update is completed (if required), the custom field will be available in OroCommerce and can be populated with data coming from iPaaS through the mapping.
Log in to the iPaaS.com portal and go to your OroCommerce subscription.
Click the Custom Fields icon.
On the Custom Fields page, click +Add Custom Field.
Create the custom field with the exactField Name and Type used in OroCommerce for the Name and Data Type of the iPaaS.com subscription custom field.
Under Module, select Product and then click Save.
To send data from iPaaS.com to OroCommerce in custom fields:
In iPaaS.com, open the relevant mapping collection and add a new mapping by selecting the desired destination custom field. The source can be configured based on the custom field requirements or specifications.
Mapping Collection Status
Mapping Status: Enabled
Trigger Events: Create, Update
Conflicting Mappings
This mapping applies only to Bulk Pricing from iPaaS. Ensure no other mappings target the same OroCommerce Price List entity to prevent data from being overwritten.
Authentication and Security
OroCommerce uses OAuth 2.0 authentication to generate an access token. This token authorizes all OroCommerce API requests during transfer operations.
Integration Flow
The integration processes iPaaS bulk pricing as follows:
The integration is triggered when a bulk pricing record is created or updated in iPaaS.
Price List details are mapped and validated against OroCommerce requirements.
If Customer categories (Applies To association) are assigned, the system verifies they have been transferred to OroCommerce.
Products and customer groups are verified or auto-created if the Auto Create Product and Auto Create Customer Group presets are enabled.
The Price List, along with its Product Prices and associated Customer Groups, is created or updated in OroCommerce.
Associated customer group assignments are processed through the child collection.
Upon successful transfer, the OroCommerce ID is saved as the External ID in iPaaS.
Sync results are logged for troubleshooting.
Supported Child Collections
This parent mapping collection supports the following child collection:
Mappings
Parent Collection: Add/Update OroCommerce Price Lists FROM iPaaS.com
Mapping Filter
TableId == 1 || TableId == 4
Description
This mapping filter controls when a Price List is allowed to be created or processed. It only allows the mapping to run for records related to products or product variants (TableId 1 or 4). Records that do not belong to these table types are ignored by the mapping.
Mapping Type | Source Field (iPaaS) | Destination Field (OroCommerce) | Description |
Dynamic Formula |
| Id | Retrieves the external ID of the Bulk Price from iPaaS. Required. |
Static | pricelists | PriceLists_Type | Sets the OroCommerce PriceLists_Type. Required. |
Static | productprices | ProductPrices_Type | Sets the OroCommerce ProductPrices_Type. Required. |
Static | organizations | PriceLists_Relationships_Organization_Type | Sets the organization relationship type. Recommended. |
Static | true | PriceLists_Attributes_Active | Sets the Price List as active. Recommended. |
Dynamic Formula |
| PriceLists_Attributes_Name | Assigns a Price List name dynamically based on the BulkPrice value. Required. |
Dynamic Formula |
| PriceLists_Attributes_PriceListCurrencies | Sets the Price List currencies to USD and EUR. Required. |
Static | 1 | Pricelists_Relationships_Organization_Id | Sets the organization ID for the Price List relationship. Recommended. |
Field | Quantity | ProductPrices_Attributes_Quantity | Maps iPaaS Quantity to Product Price Quantity. Required. |
Dynamic Formula |
| ProductPrices_Attributes_Currency | Retrieves the currency name from iPaaS by ID. Required. |
Field | BulkPrice | ProductPrices_Attributes_Value | Maps iPaaS BulkPrice to Product Price value. Required. |
Dynamic Formula |
| ProductPrices_Relationships_Product_Id | Retrieves the OroCommerce Product or Variant ID for the given InternalId. Required. |
Dynamic Formula | Checks Product then Product Variant external ID; returns the corresponding Product Unit ID. Returns null if no mapping exists. | ProductPrices_Relationships_Unit_Id | Retrieves the Product Unit ID from OroCommerce for the given Product or Product Variant. Required. |
Child: OroCommerce Add/Update Price Lists Customer Groups FROM iPaaS.com
Mapping Filter
TableId == 39
Description
This mapping filter ensures that the Applies To association contains only valid Customer Category associations.
Mapping Type | Source Field (iPaaS) | Destination Field (OroCommerce) | Description |
Static | pricelisttocustomergroups | Type | Sets the OroCommerce Type. Required. |
Static | 1 | Attributes_SortOrder | Sets the SortOrder attribute. Recommended. |
Static | false | Attributes_MergeAllowed | Sets the MergeAllowed attribute. Recommended. |
Static | customergroups | Relationships_CustomerGroup_Type | Sets the Customer Group relationship type. Required. |
Dynamic Formula |
| Relationships_CustomerGroup_Id | Retrieves the external ID of the Customer Category from iPaaS. Required. |
Error Handling
Missing Required Field
Required field is missing.
Description: OroCommerce rejected a Bulk Pricing, Price List, or Product Price create/update request due to missing required fields.
Resolution: Ensure all required fields are populated: Price List Name, Product Price Value, Quantity, Currency, Product ID, and AppliesTo Customer Groups (if applicable).
Invalid Product, Unit, or Currency
Mapping not found.
Description: OroCommerce cannot create or update the Product Price because the Product, Unit, or Currency mapping does not exist or is invalid.
Resolution: Verify that the Product external ID exists in iPaaS and OroCommerce, the Product Unit mapping exists in OroCommerce, and the Currency mapping is valid.
Category Not Found
Customer group not found.
Description: The AppliesTo customer category assigned to the Price List has not been transferred to OroCommerce.
Resolution: Transfer the Customer Category to OroCommerce before syncing the Price List.
Duplicate Price List Name
Price List name already exists.
Description: OroCommerce does not allow duplicate Price List names. The integration attempted to create a Price List with a name that already exists.
Resolution: Ensure Price List names are unique in iPaaS before syncing, or update the Bulk Pricing dynamic formula to generate a unique name.
Bulk Pricing External ID Missing
External ID not found.
Description: The Bulk Pricing record cannot be mapped because the external ID is missing or invalid.
Resolution: Ensure the Bulk Pricing has a valid iPaaS External ID, or enable AutoCreateProduct to automatically create missing products before transfer.
AppliesTo Mapping Failure
Customer Group mapping failed.
Description: The integration could not map one or more AppliesTo categories due to missing or invalid external IDs.
Resolution: Ensure all customer categories referenced in AppliesTo exist in OroCommerce and that external ID mappings are correct. Enable AutoCreateCustomerGroup to automatically create missing categories before transfer.
Currency Not Found
Invalid or unsupported currency.
Description: The price list currency value provided from iPaaS to OroCommerce is invalid or does not exist in OroCommerce. The API rejects the request because the currency code cannot be matched.
Resolution: Verify that the currency code exists and is enabled in OroCommerce. Ensure the currency value mapped in iPaaS matches a valid ISO currency configured in OroCommerce Price Lists.
OroCommerce Product ID Not Found
Product reference missing or invalid.
Description: The product could not be linked because the required product identifier is missing or invalid. OroCommerce expects a valid product SKU, but the value is blank or the referenced product entity does not exist.
Resolution: Ensure the product SKU is present and correctly mapped in iPaaS. Confirm that the product already exists in OroCommerce before transferring related records, or enable the Auto Create Product functionality to create missing products prior to synchronization.
Validation and Testing
Before deploying this integration, verify the following configuration items and run the test scenarios to confirm proper operation.
Validation Checklist
Bulk Pricing (Parent) Requirements
Bulk Pricing ID exists in iPaaS.
Price List name is unique.
Product exists in OroCommerce or Auto Create Product is enabled.
Currency and Unit mappings exist.
Product Prices Quantity is present.
Product Prices Value is set.
Product Prices Currency mapping exists.
Product Prices Product mapping exists.
Price Lists Customer Groups (Child) Requirements
Customer Group mapping exists.
Customer Category exists in OroCommerce or Auto Create Customer Group is enabled.
Test Scenarios
Scenario 1: Create/Update Bulk Pricing
Create or update a Bulk Pricing record in iPaaS with Price List and Product Price values. Sync to OroCommerce. Verify that the Price List and Product Prices are created with the correct IDs. Confirm External IDs are saved in iPaaS. Verify changes are reflected without duplicates.
Scenario 2: Create/Update Bulk Pricing Customer Group Assignment
Update the Applies To association on a Bulk Pricing record in iPaaS. Sync to OroCommerce. Verify customer group assignments are reflected without duplicates.
Scenario 3: Missing Product External ID (Failure Case)
Create a Bulk Pricing record in iPaaS with a Product that has no external ID mapping in OroCommerce. Trigger the integration. If Auto Create Product is enabled, the Product is created in OroCommerce, and the transfer succeeds. If auto-create is disabled, the integration fails with a Missing Product External ID error, and no records are created.
Scenario 4: Missing Customer Category (Failure Case)
Create a Bulk Pricing record with an Applies To category that has no mapping in OroCommerce. Trigger the integration. If Auto Create Customer Group is enabled, the category is created, and the transfer succeeds. If auto-create is disabled, the integration fails with a Category Not Found error.
Scenario 5: Invalid Currency or Unit Mapping (Failure Case)
Create or update Bulk Pricing with a Product Price referencing a currency or unit not mapped in OroCommerce. Trigger the integration. Verify the integration fails with a Currency or Unit Mapping error and that no incomplete or inconsistent Product Prices are created.
Scenario 6: Custom Field Transfer
Create a custom field in OroCommerce (Price List or Product Price). Create a matching custom field in iPaaS with the same name and module. Assign a value in iPaaS Bulk Pricing and trigger the integration. Verify that custom field values are transferred correctly and are stored using the appropriate storage type (Serialized Field or Table Column).
Additional Notes
Customer groups must be removed from Price Lists manually in OroCommerce.
Only a single unit is supported for pricing; iPaaS unit fields are ignored.
The integration supports deleted record removal for Product Prices when Bulk Pricing is deleted from iPaaS.
Custom fields require matching names between OroCommerce and iPaaS.
Serialized Field storage type is recommended for custom fields to avoid manual schema updates.
HandlePrerequisite ensures auto-creation of Products and Customer Groups if they are missing.
All exceptions are logged. Partial failures could leave Price Lists partially synced unless rollback or retry logic is implemented.