Skip to main content

Linnworks to iPaaS.com Sales Order Mapping Documentation

How Linnworks orders and their lines, addresses, payments, and notes map to iPaaS.com Transactions.

Summary

Linnworks Open Orders are transferred to iPaaS.com as Transactions. Each order's header, line items, addresses, payment, and notes are captured together and recorded against a single iPaaS.com Transaction, keeping iPaaS.com aligned with the orders in Linnworks.

ID Format

Manual Sync ID Format. On the iPaaS.com Manual Sync page, enter the Linnworks order number (for example, 197689) or the Linnworks order GUID. The integration resolves an order number to its underlying order record before retrieving the full order.

External ID Format. After a successful transfer, iPaaS.com saves the Linnworks order GUID as the external ID on a dedicated external-ID record for the Transaction. This is the primary match that routes later updates to the same Transaction instead of creating a duplicate. Before that link exists — typically on the first transfer — the integration also looks for an existing Transaction whose TransactionNumber matches the Linnworks order number and links to it automatically.

Deleted Record Support

Outbound delete is not supported. The integration does not remove Transactions from iPaaS.com when an order changes in Linnworks, and delete mappings are not included in the default templates.

Custom Field Support

The order Source (the Linnworks sales channel an order originated from) is mapped into an iPaaS.com custom field on the Transaction. No additional custom-field configuration is required in Linnworks for this collection.

Mapping Collection Status

Enabled. New and updated Open Orders are detected on the integration's polling schedule; Manual Sync is also available for any single order.

Duplicate or Conflicting Mappings

This is the only mapping collection that syncs Linnworks orders to iPaaS.com as Transactions, so there is no competing collection for this entity and direction. To prevent duplicate Transactions, the integration matches an incoming order to an existing Transaction by TransactionNumber until the external-ID link is established; if that automatic link cannot be made, the transfer stops with the message "Unable to dynamically link to existing Linnworks transaction using NumOrderId. This may result in duplicate transaction records."

Supported Child Collections

The following child collections are transferred as part of the parent order transfer and are attached to the parent Transaction:

  • Add/Update Linnworks Sales Order Line TO iPaaS.com: the order's line items.

  • Add/Update Linnworks Sales Order Address TO iPaaS.com: the shipping and billing addresses.

  • Add/Update Linnworks Sales Order Payment TO iPaaS.com: the order's payment.

  • Add/Update Linnworks Sales Order Note TO iPaaS.com: the notes on the order.

Tracking and shipping details are handled separately by the Linnworks Shipment Info collections.

System Caveats

Linnworks Caveats

  • Order capture is based on the Linnworks Open Orders view. Orders that have left Open Orders are outside the scope of the automatic poll.

  • The customer email address is taken from the order's shipping address when present, otherwise from the billing address. An order with no email address on either is not transferred.

iPaaS.com Caveats

  • Each line item's SKU must already exist as a Product in iPaaS.com. Products are not created as part of the order transfer; transfer them first.

  • TransactionNumber is used as the fallback duplicate-detection key before the external-ID link exists. Remapping it to a different source disables that fallback match for orders created before their external-ID link was recorded.

Integration Flow

  1. On its polling schedule, the integration retrieves new and updated Open Orders from Linnworks (optionally limited to the locations named in the Poll Orders By Locations setting).

  2. For each order, the integration retrieves the full order details, including its line items, addresses, notes, and tracking.

  3. The integration checks whether the order is already linked to an iPaaS.com Transaction. If it is not linked but a Transaction with a matching TransactionNumber exists, the two are linked to avoid creating a duplicate.

  4. The order must pass the mapping filter — it must have at least one line item, those items' SKUs must exist as iPaaS.com Products, and the order must have an email address — or it is not transferred.

  5. The order header is recorded as a Transaction, and its lines, addresses, payment, and notes are recorded against it.

Mappings

Add/Update Linnworks Sales Order TO iPaaS.com

Mapping Filter

var skus = Items?.Any() == true 
    ? Items.Select(x => x.ItemNumber).ToList() 
    : null;if (skus == null || skus.Count == 0)
{
    throw new Exception("No items are available, so the order will not be transferred.");
}var items = await GetiPaaSProductBySkuAsync(skus);if (items == null || items.Count == 0)
{
    throw new Exception("No items are available, so the order will not be transferred.");
}if (string.IsNullOrWhiteSpace(EmailAddress))
{
    throw new Exception("No email address is provided in either the shipping or billing address.");
}return true;

Filter Description. An order is transferred only when it has at least one line item, at least one of its item SKUs already exists as a Product in iPaaS.com, and it has an email address on its shipping or billing address. Orders that fail any check are skipped with the corresponding message shown above.

Mapping Type

Source Field (Linnworks)

Destination Field (iPaaS.com)

Description

Field

NumOrderId

TransactionNumber

Required. The Linnworks order number; also the fallback duplicate-detection key.

Static

"Order"

Type

Required. Always set to Order.

Lookup

Order status

Status

Required. Processed orders map to Complete; all others to Pending.

Field

EmailAddress

EmailAddress

Required. From the shipping address, or the billing address if none.

Field

GeneralInfo_Source

Source (custom field)

Recommended. The Linnworks sales channel.

Dynamic Formula

(platform-supplied)

SystemId

Required. The iPaaS.com system identifier, supplied automatically.

Field

TotalsInfo_Subtotal

Subtotal

Recommended. Order subtotal before shipping and tax.

Field

TotalsInfo_TotalDiscount

DiscountAmount

Recommended. Total order discount.

Field

TotalsInfo_Tax

TaxAmount

Recommended. Total order tax.

Field

TotalsInfo_PostageCost

ShippingAmount

Recommended. Order postage cost.

Field

TotalsInfo_TotalCharge

Total

Recommended. Order total charge.

Dynamic Formula

Order line quantities

TotalQty

Recommended. Sum of all line quantities.

Dynamic Formula

GeneralInfo_ReceivedDate

TransactionCreatedDateTime

Recommended. The order received date, converted to UTC.

Add/Update Linnworks Sales Order Line TO iPaaS.com

Mapping Filter

if (!string.IsNullOrEmpty(ItemNumber))
{
    var hasProduct = await GetiPaaSProductBySkuAsync(ItemNumber);
    if(hasProduct.Count > 0) {
         return true;
    }
    else {
        throw new Exception("This item is not available in iPaaS, so it cannot be transferred.");
    }}return false;

Filter Description. A line is transferred only when its SKU already exists as a Product in iPaaS.com. Lines whose SKU is not found are skipped with the message shown above; lines with no SKU are not transferred.

Mapping Type

Source Field (Linnworks)

Destination Field (iPaaS.com)

Description

Static

"Product"

Type

Required. Always set to Product.

Dynamic Formula

Parent order status

Status

Required. Line status from the parent order — Complete or Pending.

Field

ItemNumber

Sku

Required. Must exist as an iPaaS.com Product.

Field

Title

Description

Recommended. The item title.

Field

Quantity

Qty

Recommended. Ordered quantity.

Field

PartShippedQty

QtyShipped

Recommended. Quantity already shipped.

Field

PricePerUnit

UnitPrice

Recommended. Per-unit price.

Field

CostIncTax

ExtendedPrice

Recommended. Line total including tax.

Field

Discount

DiscountAmount

Recommended. Line discount.

Field

TaxRate

TaxPercent

Recommended. Tax rate percentage.

Field

Tax

EstimatedTaxAmount

Recommended. Line tax amount.

Field

Weight

Weight

Recommended. Line item weight.

Add/Update Linnworks Sales Order Address TO iPaaS.com

This collection has no mapping filter; every address on a transferred order is processed.

Mapping Type

Source Field (Linnworks)

Destination Field (iPaaS.com)

Description

Field

IsPrimaryBilling

IsPrimaryBilling

Recommended. Marks the primary billing address.

Field

IsPrimaryShipping

IsPrimaryShipping

Recommended. Marks the primary shipping address.

Field

Address1

Address1

Recommended. First address line.

Field

Address2

Address2

Recommended. Second address line.

Field

Town

City

Recommended. Town or city.

Field

Region

Region

Recommended. Region, state, or county.

Field

Country

Country

Recommended. Country.

Field

PostCode

PostalCode

Recommended. Postal or ZIP code.

Dynamic Formula

Parent postal service name

ShippingMethod

The order's postal service name.

Dynamic Formula

Parent shipping vendor

ShippingMethodDescription

The order's shipping vendor.

Dynamic Formula

Parent postage cost

ShippingAmount

The order's postage cost.

Dynamic Formula

Address full name

FirstName

The first word of the recipient's full name.

Dynamic Formula

Address full name

LastName

The second word of the recipient's full name.

Add/Update Linnworks Sales Order Payment TO iPaaS.com

Mapping Filter

SourceTypeName == "ParentOnly" && !string.IsNullOrEmpty(Parent.TotalsInfo_PaymentMethod)

Filter Description. A payment record is created only when the parent order has a payment method. Orders with no payment method do not produce a payment record.

Mapping Type

Source Field (Linnworks)

Destination Field (iPaaS.com)

Description

Dynamic Formula

Parent payment method

Method

Required. The order's payment method.

Dynamic Formula

Parent order total

Amount

Recommended. The order total as the payment amount.

Dynamic Formula

Parent order status

Status

Payment status from the parent order — Complete or Pending.

Add/Update Linnworks Sales Order Note TO iPaaS.com

This collection has no mapping filter; every note on a transferred order is processed.

Mapping Type

Source Field (Linnworks)

Destination Field (iPaaS.com)

Description

Static

"Customer Note"

Type

Required. Always set to Customer Note.

Field

Note

Text

Recommended. The note content.

Dynamic Formula

Note date

NoteCreatedDateTime

The note creation date, converted to UTC.

Dynamic Formula

Internal flag

IsPublic

Internal Linnworks notes are recorded as not public; others as public.

Error Handling

  • "No items are available, so the order will not be transferred.": The order has no line items, or none of its item SKUs exist as Products in iPaaS.com. Transfer the matching products to iPaaS.com, then re-sync the order.

  • "No email address is provided in either the shipping or billing address.": The order has no email address on either address. Add an email address to the order in Linnworks and re-sync.

  • "This item is not available in iPaaS, so it cannot be transferred.": A line item's SKU does not exist as a Product in iPaaS.com. Transfer the product first.

  • "Unable to dynamically link to existing Linnworks transaction using NumOrderId. This may result in duplicate transaction records.": The order could not be linked to an existing Transaction by TransactionNumber. Contact iPaaS.com Support if duplicate Transactions appear.

Testing & Validation

  1. Create a new Open Order in Linnworks whose items exist as iPaaS.com Products and that has a customer email, and verify a Transaction is created in iPaaS.com with its lines, addresses, payment, and notes.

  2. Update an existing order's totals or status in Linnworks and verify the change propagates to the same Transaction (no duplicate is created).

  3. Create an order with no items, or with items whose SKUs are not in iPaaS.com, and confirm it is not transferred and the expected message is recorded.

  4. Create an order with no email address and confirm it is not transferred.

  5. Manually sync an order by its Linnworks order number and confirm it transfers.

Additional Notes

  • Outbound delete is not supported (see Deleted Record Support).

  • Order tracking and shipment details are transferred by the separate Linnworks Shipment Info collections.

Related Documents

Did this answer your question?