This documentation describes how iPaaS.com transactions are transferred to ShipHawk as orders, together with their line items and addresses.
Summary
When a transaction is created or updated in iPaaS.com, the corresponding order is created or updated in ShipHawk. The transfer carries the order header along with its line items and its shipping and billing addresses, so the full order is represented in ShipHawk.
ID Format
For Manual Sync, enter the iPaaS.com transaction ID (the internal record ID) on the Manual Sync page — for example, 145146.
External ID Format. After a successful transfer, iPaaS.com records the ShipHawk Order ID as the external ID on the transaction — for example, ord_y0qrZKSrN1dt — and uses it to route later updates to the same ShipHawk order rather than creating a new one.
Deleted Record Support
Outbound delete is not supported for orders. Delete mappings are not included in the default templates, and deleting an order in iPaaS.com is not propagated to ShipHawk.
Mapping Collection Status
Mapping Status: Enabled
Trigger Events: Create, Update
Duplicate or Conflicting Mappings
This is the only mapping collection that creates ShipHawk orders from iPaaS.com transactions. Ensure no other mapping targets the same ShipHawk order data so values are not overwritten.
Collision Handling
ShipHawk rejects a second order that reuses an order number already present, returning the message order number has already been taken. When this happens, the integration detects the response, extracts the existing ShipHawk order ID from it, and reuses that order — linking the incoming order to the existing one instead of creating a duplicate. Collision matching for this collection is keyed on the order number. The order's line items and addresses are then matched to the existing order by external ID, or by SKU when no external ID is present.
Supported Child Collections
Add/Update ShipHawk Order Address FROM iPaaS.com: transfers the order's shipping and billing addresses.
Add/Update ShipHawk Order Line Item FROM iPaaS.com: transfers the order's line items, linked by external ID with SKU as a fallback match.
System Caveats
iPaaS.com Caveats
Line items link accurately only when the ShipHawk order already exists; the order header is transferred before its line items and addresses.
Line items are matched by external ID, and by SKU when an external ID is missing. Missing or inconsistent SKUs can result in duplicate line items.
The line item Currency, Length, Width, and Height values come from iPaaS.com custom fields that must exist in the subscription for those values to be sent.
ShipHawk Caveats
Until packing rules or package definitions are configured in ShipHawk, ShipHawk's default packaging splits a shipment into one package per unit.
Setup Requirements
Enable the iPaaS.com transaction create and update triggers for this collection under Outbound Data Flows in the ShipHawk subscription. No automatic transfers occur until those triggers are enabled.
Integration Flow
The transfer is triggered when a transaction is created or updated in iPaaS.com.
The order details are mapped and validated against ShipHawk's requirements.
The order header is created or updated in ShipHawk, followed by its line items and its addresses.
On success, the ShipHawk Order ID is saved as the external ID on the iPaaS.com transaction.
Mappings
Add/Update ShipHawk Order FROM iPaaS.com
The parent order collection has no mapping filter; all transactions are processed.
Mapping Type | Source Field (iPaaS.com) | Destination Field (ShipHawk) | Description |
Field | TransactionNumber | OrderNumber | Required. ShipHawk identifies the order by this value. |
Field | Id | SourceSystemId | Required. The iPaaS.com transaction ID is sent as the source-system record ID so ShipHawk can match the order on later updates. |
Field | SystemId | SourceSystem | Optional. Records the source system the order came from (for example, NetSuite, Shopify, or Magento). |
Lookup Translation | Transaction(Order) Status To iPaaS.com | Status | Optional. Translates the iPaaS.com order status to the ShipHawk status (see the table below). |
Field | Subtotal | ItemsPrice | Optional. Maps the item subtotal. |
Field | ShippingAmount | ShippingPrice | Optional. Maps the shipping amount. |
Field | TaxAmount | TaxPrice | Optional. Maps the tax amount. |
Field | Total | TotalPrice | Optional. Maps the order total. |
Lookup Translation Table — Order Status
Source Value (iPaaS.com) | Destination Value (ShipHawk) | Notes |
Pending | new | ShipHawk default status |
On Hold | on_hold | |
Complete | delivered | |
Partially Shipped | partially_shipped | |
Cancelled | cancelled | |
Shipped | shipped |
Allowed ShipHawk status values: new (the default), partially_shipped, shipped, delivered, cancelled, on_hold, picking. Subscribers or their MiSP can adjust these pairs in the iPaaS.com translation editor.
Add/Update ShipHawk Order Line Item FROM iPaaS.com
Child of the order collection. It has no mapping filter; all line items are processed.
Mapping Type | Source Field (iPaaS.com) | Destination Field (ShipHawk) | Description |
Field | Description | Name | Required. The line item name. |
Field | Sku | Sku | Required. The product SKU; also used to match the line item on updates. |
Dynamic Formula |
| SourceSystemId | Required. The line item's iPaaS.com ID, evaluated at transfer time and used with the SKU to match the line item so it is not duplicated. |
Field | Qty | Quantity | Optional. |
Field | UnitPrice | Value | Optional. The unit price. |
Field | currency | Currency | Optional. Defaults to USD when no value is provided. From an iPaaS.com custom field. |
Static |
| ItemType | Optional. Defaults to parcel; supported types are parcel, handling_unit, and unpacked. |
Field | Weight | Weight | Optional. |
Field | length | Length | Optional. Must be convertible to a decimal. From an iPaaS.com custom field. |
Field | width | Width | Optional. Must be convertible to a decimal. From an iPaaS.com custom field. |
Field | height | Height | Optional. Must be convertible to a decimal. From an iPaaS.com custom field. |
Add/Update ShipHawk Order Address FROM iPaaS.com
Child of the order collection. It has no mapping filter; all addresses are processed. ShipHawk requires either a name or a company on an address, along with the street, city, state, ZIP, and country.
Mapping Type | Source Field (iPaaS.com) | Destination Field (ShipHawk) | Description |
Dynamic Formula |
| Name | Required unless a company is provided — builds the recipient name from the first and last name. |
Field | Company | Company | Required when no recipient name is provided; otherwise optional. |
Field | Address1 | Street1 | Required. The primary street address. |
Field | City | City | Required. |
Field | Region | State | Required. The state or region. |
Field | PostalCode | Zip | Required. The postal or ZIP code. |
Dynamic Formula |
| Country | Required. Converts the country name to its two-letter ISO code (for example, United States becomes US). |
Field | Address2 | Street2 | Optional. Suite, unit, and similar. |
Dynamic Formula | Email from the parent order record | Optional. Populated from the order header rather than the address itself. | |
Field | Phone | PhoneNumber | Optional. From an iPaaS.com custom field. |
Field | IsPrimaryShipping | IsPrimaryShipping | Optional. Marks this as the ShipHawk shipping address. |
Field | IsPrimaryBilling | IsPrimaryBilling | Optional. Marks this as the ShipHawk billing address. |
Field | ShippingMethod | RequestedShippingDetails | Optional. Usually a Carrier - Service pair; can be used in ShipHawk rules. |
Error Handling
Required field missing: ShipHawk rejects the order when a required field is absent. Resolution: ensure the required fields are populated (OrderNumber, SourceSystemId, and, on each line item, Name and Sku).
Duplicate order: the order number already exists in ShipHawk. Resolution: collision handling reuses the existing ShipHawk order; confirm collision handling is enabled on the collection to avoid duplicates.
External ID missing: a line item cannot be matched to the ShipHawk order. Resolution: ensure the order transferred successfully so its external ID exists; line items fall back to SKU matching when no external ID is present.
Invalid SKU: a line item cannot be linked because its SKU does not match. Resolution: verify SKUs are consistent between iPaaS.com and ShipHawk.
Testing & Validation
Test Scenarios
Create or update a transaction in iPaaS.com and sync it to ShipHawk; verify the order, its line items, and its addresses are created or updated correctly.
Sync a transaction whose order number already exists in ShipHawk; verify the existing ShipHawk order is reused and no duplicate is created.
Sync a transaction whose line items have no external ID; verify line items are matched by SKU when available, or an error is logged when they cannot be matched.
Validation Checklist
The transaction exists in iPaaS.com and its external ID is valid.
All line items have a valid SKU or external ID.
Addresses include a name or company plus street, city, state, ZIP, and country.
Line item quantities and values are valid.
Additional Notes
The line item source ID is mapped with a Dynamic Formula so the ID is evaluated at transfer time; this is required for correct line-item matching when an order is updated.
The line item Currency, Length, Width, and Height values, and the address Phone value, come from iPaaS.com custom fields that must exist in the subscription.
The address email is taken from the parent order record rather than from the address itself.