Summary
Shipment tracking details are brought from ShipHero into iPaaS.com and recorded against the order the shipment belongs to. When ShipHero ships an order, its tracking number, shipping method, cost, shipped SKUs and quantities, and ship date are captured and linked to the matching iPaaS.com Transaction as its tracking-number record.
ID Format
Manual Sync ID Format. Enter the ShipHero order identifier on the Manual Sync page to bring that order's shipment tracking details into iPaaS.com.
External ID Format. iPaaS.com records the shipment as a tracking-number record linked to the matching iPaaS.com Transaction, resolved during the transfer from the ShipHero order.
Deleted Record Support
Not applicable. This collection brings shipment tracking details into iPaaS.com; it does not delete shipment or tracking records.
Mapping Collection Status
Enabled with a mapping filter. Shipments that satisfy the filter (below) are processed; shipments that do not are rejected with a message naming what must exist in iPaaS.com first.
Supported Child Collections
None.
System Caveats
ShipHero Caveats
The tracking number, shipping method, and cost are taken from the shipment's shipping label.
iPaaS.com Caveats
The order (Transaction) and the shipping method must exist in iPaaS.com before a shipment for them can be brought across.
Integration Flow
ShipHero reports a shipment, delivered automatically when the subscriber enables the Shipment Update event under Inbound Data Flows, or fetched on demand via Manual Sync.
The integration resolves the iPaaS.com Transaction from the ShipHero order and records the shipment's tracking details against it.
Mappings
Add/Update ShipHero Shipment TO iPaaS.com
Mapping Filter
Resolve the iPaaS.com Transaction from the ShipHero order. If the shipment is not linked to any Transaction -> reject the shipment. Check that the shipment's shipping method (carrier) exists in iPaaS.com. If it does not -> reject the shipment. Otherwise -> process the shipment.
Filter Description. The collection processes a shipment only when both the order it belongs to and its shipping method already exist in iPaaS.com. If the order is not present, the shipment is rejected with "Transaction Tracking Number is not linked to any Transaction." — the order must be in iPaaS.com first. If the shipping method is missing, the shipment is rejected with "Shipping Method needs to be created manually in iPaaS.com first." — create the matching shipping method first.
Mapping Type | Source Field (ShipHero) | Destination Field (iPaaS.com) | Description |
Dynamic Formula | (Transaction resolved from the order) | ParentId | Required. Links the shipment to the iPaaS.com Transaction. |
Field | Id | Id | The ShipHero shipment identifier. |
Dynamic Formula | ShippingLabel Tracking Number | TrackingNumber | Core value — the shipment's tracking number. |
Dynamic Formula | ShippingLabel Carrier | ShippingMethod | The carrier; must exist as a shipping method in iPaaS.com. |
Dynamic Formula | ShippingLabel Cost | Cost | Recommended. Shipping cost. |
Dynamic Formula | (shipped line SKUs, combined) | Shipped Sku | Recommended. SKUs shipped, separated by a vertical bar. |
Dynamic Formula | (shipped line quantities, combined) | Shipped Quantity | Recommended. Quantities shipped, in the same order as the SKUs. |
Dynamic Formula | (shipment created date) | Created time stamp | Recommended. When the shipment was created in ShipHero. |
Error Handling
Errors appear in Dashboard > Integration Monitoring > Error Logs. For the transaction-not-linked and shipping-method-not-found messages and how to resolve them, see the ShipHero Error Messages article in the iPaaS.com Help Center.
Testing & Validation
With the order and shipping method present in iPaaS.com, ship an order in ShipHero and confirm the tracking details appear on the iPaaS.com Transaction.
Ship an order whose Transaction is not in iPaaS.com and confirm the shipment is rejected with the documented message.
Ship an order using a carrier with no matching iPaaS.com shipping method and confirm the documented message.
Additional Notes
Shipment data is captured from ShipHero. The shipped SKUs and quantities are recorded as combined lists in matching order.