Skip to main content

iPaaS.com to ShipHero Sales Order Mapping Documentation

Field mappings for transferring sales orders, addresses, and line items from iPaaS.com to ShipHero.

Summary

Sales orders are transferred from iPaaS.com to ShipHero. When a Transaction is added or updated in iPaaS.com, the corresponding sales order — its header, shipping and billing addresses, and line items — is created or updated in ShipHero for fulfillment. Addresses and line items are handled by child mapping collections that run as part of the order transfer.

ID Format

Manual Sync ID Format. On the iPaaS.com Manual Sync page, enter the iPaaS.com Transaction record ID for the order (for example, 197689).

External ID Format. After the order is created in ShipHero, iPaaS.com saves the ShipHero order identifier as the external ID on a dedicated external-ID record for the Transaction; that record routes later updates to the same ShipHero order. When no external-ID record yet exists, the integration also looks up an existing ShipHero order by its order number and links to it, preventing duplicates. Each address is linked by a composite identifier (ORDERID|ShippingAddress or ORDERID|BillingAddress) and each line item by its ShipHero line identifier.

Deleted Record Support

Outbound delete is not supported. Deleting a Transaction in iPaaS.com does not remove the corresponding order in ShipHero.

Mapping Collection Status

Enabled. The Sales Order collections have no mapping filter applied, so all dispatched Transactions are processed.

Duplicate or Conflicting Mappings

The Add and Update Sales Order collections operate on the same ShipHero order entity. Whether an event creates a new order or updates an existing one is determined by whether the order is already linked to ShipHero by an external ID, not by which collection or trigger fired. Review both collections' behavior so a single source of truth determines create-versus-update.

Supported Child Collections

  • Sales Order Address (Add and Update): creates or updates the order's shipping and billing addresses in ShipHero, linked to the order by a composite identifier.

  • Sales Order Line (Add and Update): creates or updates the order's line items in ShipHero, linked by their ShipHero line identifiers. Line items added after the order was created are created during an update.

System Caveats

ShipHero Caveats

  • Order splitting (allow_split): on order creation, any provided split value is ignored; ShipHero always sets it to true by default.

  • Subtotal and total price: ShipHero calculates the order subtotal and total from line-item pricing and ignores supplied values, so the integration sends no subtotal or total price. (ShipHero's response has been observed to return a doubled subtotal while its interface shows the correct value.)

  • Line item SKU on update: ShipHero does not accept a SKU when an existing line item is updated, so the integration omits it on updates; new line items added during an update are created with their SKU.

  • API credit limits: ShipHero's API is credit-based; line items are created and updated in batches to stay within the limits.

iPaaS.com Caveats

  • The Transaction should carry its shipping address and line items; ShipHero requires at least one line item, each with a SKU, quantity, and price, to create an order.

  • Line-item SKUs should identify products that exist in ShipHero or can be created there (see Integration Flow).

Integration Flow

  1. A Transaction is dispatched from iPaaS.com (automatically via the transaction/created or transaction/updated outbound triggers enabled under Outbound Data Flows, or on demand via Manual Sync).

  2. Any line-item product that does not yet exist in ShipHero is transferred to ShipHero first, automatically, matched by SKU. If a required product cannot be created, the order transfer does not complete.

  3. The order header is created (order_create) or updated (order_update) in ShipHero.

  4. The order's line items are created or updated in batches (up to 30 per request); line items added since the order was created are created during an update.

  5. ShipHero returns the order and line identifiers, which iPaaS.com saves as the Transaction's and lines' external IDs.

Mappings

Add/Update ShipHero Sales Order FROM iPaaS.com

This collection has no mapping filter; all records are processed.

Mapping Type

Source Field (iPaaS.com)

Destination Field (ShipHero)

Description

Field

TransactionNumber

OrderNumber

Required. ShipHero rejects an order with no order number; also the fallback match key for linking existing orders.

Field

EmailAddress

Email

Recommended. Customer contact email for the order.

Dynamic Formula

(Transaction created date, formatted as text)

OrderDate

Recommended. Converts the iPaaS.com date-time to the sortable text format ShipHero expects.

Field

ShippingAmount

Price

Recommended. Shipping charge on the order's shipping line.

Dynamic Formula

(shipping method from the primary shipping address)

Title

Optional. Sets the shipping-line title to the order's shipping method.

Field

TaxAmount

TotalTax

Recommended. Total tax on the order.

Field

DiscountAmount

TotalDiscounts

Recommended. Total discount on the order.

Dynamic Formula

(none)

Subtotal

Optional. Left unset by design — ShipHero calculates the subtotal.

Dynamic Formula

(none)

TotalPrice

Optional. Left unset by design — ShipHero calculates the total.

Dynamic Formula

(concatenated Transaction notes)

PackingNote

Optional. Combines all Transaction notes into one packing note.

Add/Update ShipHero Sales Order Address FROM iPaaS.com

Mapping Type

Source Field (iPaaS.com)

Destination Field (ShipHero)

Description

Field

IsPrimaryBilling

IsDefaultBilling

Indicates the billing address; determines placement on the order.

Field

IsPrimaryShipping

IsDefaultShipping

Indicates the shipping address; determines placement on the order.

Field

FirstName

FirstName

Recommended. Recipient first name.

Field

LastName

LastName

Recommended. Recipient last name.

Field

Company

Company

Optional. Business name.

Field

Address1

Address1

Recommended. First address line.

Field

Address2

Address2

Optional. Second address line.

Field

City

City

Recommended.

Field

Region

State

Recommended.

Field

PostalCode

Zip

Recommended.

Field

Country

Country

Recommended.

Add/Update ShipHero Sales Order Line FROM iPaaS.com

Mapping Type

Source Field (iPaaS.com)

Destination Field (ShipHero)

Description

Field

Sku

Sku

Required. ShipHero identifies each line by SKU. Not accepted when updating an existing line.

Field

Qty

Quantity

Required. Units ordered.

Field

UnitPrice

Price

Required. Unit price of the line.

Field

Description

ProductName

Recommended. Line product name.

Dynamic Formula

(iPaaS.com line ID)

PartnerLineItemId

Required. Lets ShipHero echo the value back so the integration can match and link each created line.

Error Handling

Errors from these collections appear in Dashboard > Integration Monitoring > Error Logs. For the full catalog — including the order-linking, prerequisite-product, and unexpected-response messages — and how to resolve them, see the ShipHero Error Messages article in the iPaaS.com Help Center.

Testing & Validation

  1. Create a Transaction in iPaaS.com with a shipping address and at least one line item, sync it, and confirm the order appears in ShipHero with its address and lines.

  2. Update a field on the Transaction (for example, a quantity) and confirm the change propagates to the ShipHero order.

  3. Attempt to sync an order with a line-item SKU that does not exist in ShipHero and confirm the product is transferred first, or that the expected error appears if it cannot be created.

  4. Manually sync using the documented iPaaS.com Transaction ID and confirm success.

Additional Notes

Outbound delete is out of scope. The order subtotal and total price are managed by ShipHero and are intentionally not sent from iPaaS.com.

Related Documents

Did this answer your question?