Overview
When a Transaction Tracking Number is created or updated in iPaaS.com, the corresponding Shipping Tracking record is created or updated in OroCommerce under the associated Sales Order. This mapping ensures accurate synchronization of Transaction Tracking data with OroCommerce.
Before You Begin
Ensure the following prerequisites are in place before configuring this integration.
iPaaS.com Requirements
Transaction Tracking Number records must have valid Tracking Number and Shipping Method
Parent Transaction (Sales Order) must exist and be linked
Transaction must already be transferred to OroCommerce before creating shipping tracking
OroCommerce Requirements
The associated Sales Order must exist in OroCommerce
API credentials must have permission to create/update shipping tracking records
ID Format
When manually transferring a Transaction Tracking Number from iPaaS.com, enter the valid iPaaS.com Transaction Tracking Number ID (internal ID) into the input field on the iPaaS.com manual sync page.
Example: 145146|46653
External ID Format
The OroCommerce Shipping Tracking ID will be saved as the external ID.
Example: 25
Mapping Collection Status
Status: Enabled
Trigger Events: Create, Update
Duplicate or Conflicting Mappings
This mapping applies only to Transaction Tracking Number records. Ensure no other mappings target the same OroCommerce entity to prevent data from being overwritten.
Supported Child Collections
This integration does not support any child collections.
Authentication and Security
OroCommerce uses OAuth 2.0 authentication to generate an access token, which is then used to authorize all OroCommerce API requests in transfer operations. Ensure credentials are stored securely within the iPaaS.com credential manager.
Integration Flow
The integration processes iPaaS.com Transaction Tracking Number records as follows:
Transaction Tracking Number is created or updated in iPaaS.com.
Mapping filter validates the associated Sales Order exists in OroCommerce by retrieving the external Order ID.
If no matching Order ID is found, the transfer is skipped.
iPaaS.com authenticates with OroCommerce using OAuth 2.0.
Shipping tracking attributes are mapped (Method, Number).
Order relationship is established using the external Order ID.
Shipping Tracking record is created or updated in OroCommerce.
OroCommerce Shipping Tracking ID is saved as External ID in iPaaS.com.
Transfer status and any errors are logged in iPaaS.com.
Mappings
OroCommerce Shipping Tracking Add/Update FROM iPaaS
Mapping Filter
var orderId = await GetExternalIdAsync(Id.Split('|')[0], "Transaction", SpaceportSystemId); if(orderId == null) return false; return true;Description
This logic retrieves the external Order ID by extracting the Transaction ID and querying the system. If no matching Order ID is found, the process stops and returns false; otherwise, it confirms the existence of the Order ID and returns true.
Mapping Type | Source (iPaaS.com) | Destination (OroCommerce) | Description |
Static | ordershippingtrackings | Type | (Required) Type must be set as "ordershippingtrackings". This is case sensitive. |
Field | ShippingMethod | Attributes_Method | (Required) Maps the iPaaS.com ShippingMethod field to the OroCommerce shipping method. |
Field | TrackingNumber | Attributes_Number | (Required) Maps the iPaaS.com TrackingNumber field to the OroCommerce tracking number. |
Dynamic Formula |
| Relationships_Orders_Id | (Required) Retrieves the external Order ID by extracting the Transaction ID. The returned Order ID is used to associate the tracking with the corresponding Sales Order. |
Static | orders | Relationships_Orders_Type | (Required) Order Type must be set as "orders". This is case sensitive. |
Error Handling
Order ID Not Found
Description: This error occurs when the system rejects a Shipping Tracking create or update request because the Order ID provided does not exist in OroCommerce.
Resolution: Ensure the associated Sales Order exists in OroCommerce before creating shipping tracking. Transfer the order first if needed.
Missing Shipping Method
Description: The Attributes_Method field is empty or not mapped.
Resolution: Ensure the ShippingMethod field is populated in iPaaS.com and properly mapped.
Missing Tracking Number
Description: The Attributes_Number field is empty or not mapped.
Resolution: Ensure the TrackingNumber field is populated in iPaaS.com and properly mapped.
Validation and Testing
Before deploying this integration, verify the following configuration items and run the test scenarios to confirm proper operation.
Validation Checklist
Shipping Method Name field (Attributes_Method) is present and not empty.
The Shipping Tracking Number field (Attributes_Number) is present and not empty.
Shipping Tracking Type is set to "ordershippingtrackings" (case sensitive).
Relationships_Orders_Type is set to "orders" (case sensitive).
Relationships_Orders_Id is mapped, and the dynamic formula returns valid output.
The associated Sales Order exists in OroCommerce.
Test Scenarios
Scenario 1: Create Shipping Tracking
Sync a new Transaction Tracking Number from iPaaS.com. Shipping Tracking should be created in OroCommerce under the associated Sales Order. OroCommerce Shipping Tracking ID should be saved as an External ID in iPaaS.com.
Scenario 2: Update Existing Shipping Tracking
Update an existing Transaction Tracking Number in iPaaS.com. Changes should be reflected in OroCommerce without creating duplicates.
Scenario 3: Order Not Found (Failure Case)
Attempt to create shipping tracking for an order that does not exist in OroCommerce. The transfer should be skipped by the mapping filter.
Scenario 4: Missing Required Fields (Failure Case)
Attempt to create shipping tracking without a Shipping Method or Tracking Number. Transfer should fail with an appropriate error message.
Additional Notes
Ensure dynamic formulas return valid output; null or invalid returns may cause transfer failures.
The mapping filter prevents shipping tracking creation if the associated order does not exist in OroCommerce.
All type values ("ordershippingtrackings" and "orders") are case sensitive.
The Transaction ID is extracted from the composite ID format (e.g., 145146|46653) to retrieve the associated Order ID.
Sales Orders must be transferred to OroCommerce before their associated shipping tracking records.