Contents
Summary
This collection brings shipment data from ShipStation into iPaaS.com. For each new or updated shipment, it writes a tracking record carrying the tracking number, shipment cost, shipping method and description, and the ShipStation carrier code, linked back to the iPaaS.com order the shipment belongs to. Shipments are brought in by polling ShipStation for new and updated shipments, and may also be pulled on demand with a Manual Sync. The sync type is Add/Update, so a shipment brought in again updates the existing tracking record rather than creating a duplicate.
ID Format
For a Manual Sync of a shipment inbound from ShipStation, the identifier entered is the ShipStation shipment ID.
Pattern: the numeric ShipStation shipment identifier.
Example: 123456.
The resulting tracking record is attached to a parent iPaaS.com Transaction, which is resolved automatically from the order the shipment belongs to. Subscribers do not enter the parent identifier; it is resolved during the transfer.
Deleted Record Support
Outbound delete is not implemented for this collection. The integration brings shipment data into iPaaS.com but does not propagate deletions: removing a shipment in ShipStation does not remove the corresponding tracking record in iPaaS.com, and no delete mapping is included in the default template. Subscribers who need to remove a tracking record should do so directly in iPaaS.com.
Custom Field Support
The ShipStation carrier code is carried onto a dedicated iPaaS.com custom field named Shipstation Shipping Method. This is a routine custom-field mapping that preserves the carrier identifier (the carrier that handled the shipment) for reference and downstream use. No subscriber configuration is required for this mapping to function; the carrier code is brought across as supplied by ShipStation.
Mapping Collection Status
Enabled. No filter is applied, so all shipments brought in from ShipStation are processed.
Trigger Events: shipments are brought into iPaaS.com by polling ShipStation for new and updated shipments. Subscribers or their MiSP may also run a Manual Sync at any time to pull a specific shipment on demand by entering its ShipStation shipment ID.
Duplicate or Conflicting Mappings
None. This is the single collection that handles ShipStation shipments inbound to iPaaS.com. No collision handling is implemented; the Add/Update sync type means a shipment brought in again updates the existing tracking record rather than creating a duplicate.
Supported Child Collections
None. This collection has no child collections and is not itself a child of another collection.
System Caveats
ShipStation Caveats
A shipment can only be linked to its order in iPaaS.com if the corresponding order has already been brought into iPaaS.com. There are no automatic dependency transfers: a parent order that does not already exist in iPaaS.com is not created automatically when a shipment arrives. A shipment brought in before its parent order exists cannot be attached and will not produce a linked tracking record. Subscribers should ensure orders are brought into iPaaS.com ahead of their shipments.
iPaaS.com Caveats
The subscription connection test reports success without fully validating the supplied ShipStation credentials. Subscribers should verify their credentials by running a test transfer rather than relying on the connection test alone. Beyond the parent-order requirement described above, there are no additional iPaaS.com caveats for this collection.
Setup Requirements
To bring shipments into iPaaS.com:
Ensure the parent order has already been brought into iPaaS.com, so the parent resolution can attach the tracking record to the correct Transaction.
Shipments are brought in by polling and by Manual Sync. Polling brings new and updated shipments in on its own schedule, and a Manual Sync pulls a specific shipment on demand by its ShipStation shipment ID. No shipment webhook setup is involved.
For the connection and subscription steps, and for the full installation walkthrough, refer to the ShipStation Connections and Settings and ShipStation Installation Instructions articles rather than duplicating those steps here.
Integration Flow
The integration polls ShipStation for new and updated shipments, or a subscriber or their MiSP runs a Manual Sync for a specific shipment using its ShipStation shipment ID.
The integration retrieves the shipment and resolves the parent order it is associated with, looking up the matching iPaaS.com Transaction.
The integration writes a tracking record in iPaaS.com carrying the tracking number, shipment cost, shipping method and description, and the ShipStation carrier code, and attaches it to the resolved parent Transaction.
If the same shipment is brought in again, the existing tracking record is updated in place rather than duplicated. If the parent order does not yet exist in iPaaS.com, the tracking record cannot be linked.
Mappings
Add/Update ShipStation Shipment TO iPaaS.com
iPaaS.com data type: Transaction Tracking Number.
This collection writes a tracking record in iPaaS.com for each new or updated ShipStation shipment, carrying the tracking number, cost, shipping method and description, and the ShipStation carrier code, linked back to the parent order the shipment belongs to.
Mapping Type | Source Field (ShipStation) | Destination Field (iPaaS.com) | Description |
Field | trackingNumber | TrackingNumber | Required. Carries the carrier tracking number for the shipment into the iPaaS.com tracking record. This is the core tracking value. The iPaaS.com record does not strictly enforce it, but it is functionally required: a tracking record with no tracking number provides no shipment visibility, so subscribers should keep this mapping populated. |
Dynamic Formula | (see formula below) | ParentId | Required. Resolves the parent iPaaS.com Transaction that the shipment belongs to, so the tracking record links to the correct order. The iPaaS.com record does not strictly enforce this field, but it is functionally required: without a resolved parent, the tracking record is orphaned and is not attached to any order in iPaaS.com. For the formula to resolve, the parent order must already exist in iPaaS.com before the shipment is brought in. |
Field | shipmentCost | Cost | Recommended. Carries the shipment cost reported by ShipStation into the tracking record so it reflects the actual cost of the shipment. If ShipStation does not report a cost for a given shipment, the field is left empty and the record still transfers. |
Field | serviceCode | ShippingMethod | Recommended. Carries the ShipStation service code (the carrier service selected for the shipment) into the shipping-method value on the tracking record. If the source service code is empty, the field is left empty and the record still transfers. |
Field | serviceCode | ShippingMethodDescription | Recommended. Carries the same ShipStation service code into the shipping-method description on the tracking record, giving a readable label alongside the shipping-method value. If the source service code is empty, the field is left empty and the record still transfers. |
Field | carrierCode | Shipstation Shipping Method (custom field) | Recommended. Carries the ShipStation carrier code (the carrier that handled the shipment) onto a dedicated iPaaS.com custom field named Shipstation Shipping Method, preserving the carrier identifier for reference and downstream use. If the source carrier code is empty, the custom field is left empty and the record still transfers. |
The ParentId dynamic formula resolves the parent iPaaS.com Transaction the shipment belongs to:
return await GetSpaceportIdAsync(orderId, "Transaction", SpaceportSystemId);
Each tracking record is linked to its parent order through this parent-resolution step. For the resolution to succeed, the parent order must already exist in iPaaS.com when the shipment is brought in. A shipment brought in before its parent order exists cannot be attached and will not produce a linked tracking record.
Error Handling
For the list of error messages this collection can produce and how to resolve them, refer to the ShipStation Error Messages article.
Testing and Validation
Test Scenarios
Bring a shipment into iPaaS.com for an order that already exists in iPaaS.com, and confirm a tracking record is created and linked to the correct order.
Bring the same shipment in a second time and confirm the existing tracking record is updated in place rather than duplicated.
Bring in a shipment whose parent order does not yet exist in iPaaS.com and confirm the tracking record is not linked, then bring in the order and re-run the shipment to confirm the link resolves.
Run a Manual Sync using a known ShipStation shipment ID and confirm the expected shipment is pulled.
Bring in a shipment that has no reported cost or an empty service code and confirm the record still transfers with those fields left empty.
Validation Checklist
The tracking record carries the expected tracking number.
The tracking record is attached to the correct parent order in iPaaS.com.
The shipment cost, shipping method, and shipping-method description reflect the source shipment where ShipStation supplied them.
The ShipStation carrier code appears on the Shipstation Shipping Method custom field.
Re-bringing the same shipment updates the existing record rather than creating a duplicate.
Additional Notes
Shipment deletion is out of scope. The integration does not remove tracking records in iPaaS.com when a shipment is removed in ShipStation.
Shipments are brought in by polling and Manual Sync only. Live webhook registration is not used for shipments, and subscribers should not rely on shipment webhooks to drive inbound shipment data.
For the full set of integration-wide constraints, refer to the ShipStation Integration Known Limitations article.