See what the OroCommerce integration can do →
Before You Begin
Before you can install the OroCommerce subscription, you need the Client ID, Client Secret, and Redirect URL from your OroCommerce instance. To obtain these, create an OAuth application in the OroCommerce back-office admin panel.
To Create an OAuth Application
Log in to the OroCommerce back-office (admin panel).
Navigate to System > User Management > OAuth Applications.
Click Create OAuth Application in the top right.
Select the Organization and click Continue.
Fill in the Create OAuth Application page with the following:
Application Name: give it a descriptive name (for example, your iPaaS.com subscription name).
Active: check this option.
Grant Type: select Authorization Code. This integration uses the Authorization Code flow, and selecting it reveals the Redirect URLs field.
Confidential Client: check this option.
Redirect URLs: enter the iPaaS.com callback URL for your environment (see the Redirect URL field in the Installation Instructions section below).
Click Save and Close.
Copy Your Credentials
After saving, OroCommerce displays a dialog with your Client ID and Client Secret. Click the copy icon next to each and save them somewhere secure.
NOTE: The Client Secret is shown only once, immediately after creation. You will not be able to view it again later, so store it securely before closing the dialog.
NOTE: OAuth applications can only be created after the OroCommerce instance has its OAuth encryption keys configured. If the back-office reports that OAuth authorization is unavailable, ask your OroCommerce administrator to complete the encryption key configuration first.
Installation Instructions for Integration Setup
Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the OroCommerce integration tile.
Click the Subscribe button.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: OroCommerce – Release
Select Create Default Mappings (recommended). If you do not want to create default mappings and prefer to create all mappings yourself, un-check this box.
Enter the API URL, your OroCommerce instance API endpoint. The API URL is instance-based and unique to each OroCommerce instance.
Example:
https://yourdomain.oro-cloud.com
Enter the Admin Base Path, the root URL path to your OroCommerce backend administration interface. This is used to construct API endpoint URLs.
Example:
/admin
Enter the Client ID, retrieved above in the Before You Begin section.
Enter the Client Secret, retrieved above in the Before You Begin section.
Enter the Redirect URL, the callback URL where OroCommerce sends the user (with the authorization code) after successful OAuth authentication. This must match the Redirect URL configured on the OAuth application.
Staging example:
https://stagingportal.ipaas.com/customer/subscription-mgmt/subscriptions/authorization/appProduction: use the equivalent
https://portal.ipaas.com/...URL.
Under Auto Create Product, select True or False. When True, products referenced in incoming product pricing are automatically created in OroCommerce if they do not already exist. When False, the sync fails records that reference an unknown product.
Under Auto Create Customer Group, select True or False. When True, customer groups referenced in incoming price lists are automatically created in OroCommerce if they do not exist. When False, the sync fails records that reference an unknown customer group.
Enter the Default Pricing Custom Field Name. This is the entity field name of a boolean-type field from the OroCommerce Product Price module. The boolean field is required to explicitly identify whether a given price record represents the default price for the product. The integration relies on this field to distinguish the default pricing entry from other pricing records during synchronization and update operations.
Enter the Order Poll Days. This is how many days back the integration looks when polling OroCommerce for new and updated orders. Set this wide enough to cover the gap between polls so that no order is missed.
Default Value: 1
Enter the API Throttle Limit. This setting controls the number of API requests that can run within the throttle window, protecting system performance and ensuring fair usage.
Initial Setup: 5
Ongoing and High-Volume Operations: up to 500
Enter the API Throttle Seconds. This defines the time window, in seconds, over which the API Throttle Limit is measured. If the integration makes too many requests within this window, additional requests are rejected until the window resets.
Default Value: 60
Enter the Concurrent Connections. This specifies the maximum number of simultaneous API connections the subscription will process. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 1–10
Enter the Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions the integration will run at one time. If this limit is exceeded, new requests are queued or rejected until a currently active execution finishes.
Default Value: 5
Range: 1–10
Click Apply to save the settings.
OAuth Authentication
This integration authenticates with OroCommerce using OAuth 2.0 with the Authorization Code flow. iPaaS.com uses the Client ID, Client Secret, and Redirect URL you supplied to obtain an access token, and refreshes that token automatically as needed.
To initiate the OAuth 2.0 flow and generate an access token:
Go to your OroCommerce Subscription Settings.
Click the Authentication icon.
Enter your OroCommerce login credentials.
While logged into OroCommerce, click Authorize when prompted.
On the next page, click Close Page.
Refresh the subscription. The access token value should now be present.
Post-Installation Verification
After completing the installation, perform these tests to verify it.
NOTE: Initialization (a bulk import of existing data on first connect) is not supported for OroCommerce in iPaaS.com. All data synchronization is handled through the mappings, which transfer records as they are created or updated.
Data Sync Test
Initiate a sample data pull (to iPaaS.com).
Initiate a sample data push (from iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate key features such as field mappings, workflow triggers, and logging.
Review the integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: iPaaS.com Documentation
Support Portal: iPaaS.com Support Portal
Contact Information: Contact iPaaS.com