Summary
iPaaS.com shipment records add and update the shipping and tracking information on the corresponding Linnworks order — the postal service, postage cost, and tracking number. Separate collections handle adding and updating shipment information.
ID Format
Manual Sync ID Format. On the iPaaS.com Manual Sync page, enter the iPaaS.com shipment identifier to transfer a single shipment on demand.
External ID Format. The shipment is applied to the Linnworks order that corresponds to the originating iPaaS.com Transaction, located by the order's external-ID link.
Deleted Record Support
Outbound delete is not supported. Shipment information is added or updated only; delete mappings are not included in the default templates.
Mapping Collection Status
Enabled. On add, a shipment is transferred only when the corresponding Linnworks order can be found (see the filter below). The update collection has no filter.
Duplicate or Conflicting Mappings
Shipment information is handled by an Add collection and an Update collection for the same entity. They operate on the same order's shipment and are distinguished by whether the shipment is being added or updated.
System Caveats
Linnworks Caveats
The Linnworks order that corresponds to the iPaaS.com Transaction must already exist before its shipment can be added or updated.
iPaaS.com Caveats
The postal service is set by matching a Linnworks postal service by name (see the placeholder note below).
Integration Flow
The integration locates the Linnworks order that corresponds to the originating iPaaS.com Transaction using the order's external-ID link.
On add, if no matching order is found, the shipment is not added and an error is recorded.
The postal service, postage cost, and tracking number are set on the Linnworks order's shipping information.
Mappings
Add Linnworks Shipment Info FROM iPaaS.com
Mapping Filter
var orderId = await GetExternalIdAsync(Id.Split('|')[0], "Transaction", SpaceportSystemId);
if(orderId == null)
throw new Exception($"No Transaction found for the order (orderId: {Id.Split('|')[0]}) and Order Tracking : (trackingId: {Id}). Cannot add Shipping Info");
return true;Filter Description. A shipment is added only when a matching Linnworks order can be found for the originating Transaction. When no matching order is found, the shipment is not added and the message shown above is recorded.
Mapping Type | Source Field (iPaaS.com) | Destination Field (Linnworks) | Description |
Dynamic Formula | Postal service lookup | PostalServiceId | Required. Looks up a Linnworks postal service named Standard (see placeholder note). |
Dynamic Formula | Order external-ID lookup | ShippingInfo_OrderId | Required. Identifies the Linnworks order to attach the shipment to. |
Field | Id | Id | Required. The shipment identifier. |
Field | Cost | PostageCost | Recommended. The shipping cost. |
Field | TrackingNumber | TrackingNumber | Recommended. The tracking number. |
Update Linnworks Shipment Info FROM iPaaS.com
This collection has no mapping filter; a shipment update applies when the corresponding Linnworks order exists.
Mapping Type | Source Field (iPaaS.com) | Destination Field (Linnworks) | Description |
Dynamic Formula | Postal service lookup | PostalServiceId | Required. Looks up a Linnworks postal service named Standard (see placeholder note). |
Dynamic Formula | Order external-ID lookup | ShippingInfo_OrderId | Required. Identifies the Linnworks order the update applies to. |
Field | Cost | PostageCost | Recommended. The shipping cost. |
Field | TrackingNumber | TrackingNumber | Recommended. The tracking number. |
Placeholder Values to Replace Before Go-Live
Placeholder value — replace during implementation: the postal service is set by looking up a Linnworks service named Standard. A Linnworks postal service named Standard must exist in your account, or the mapping formula must be updated to match a service that does exist, before enabling these collections.
Error Handling
"No Transaction found for the order ... Cannot add Shipping Info": No matching Linnworks order was found for the originating Transaction. Ensure the order has been transferred to Linnworks before adding its shipment.
Testing & Validation
Add a shipment for an order that exists in Linnworks and verify the postal service, postage cost, and tracking number appear on the Linnworks order.
Add a shipment for an order that does not exist in Linnworks and confirm it is not added and the expected message is recorded.
Update an existing shipment and verify the tracking details change on the Linnworks order.
Confirm a Linnworks postal service named Standard exists (or adjust the mapping) before relying on automatic transfers.
Additional Notes
Outbound delete is not supported (see Deleted Record Support).