Summary
This documentation covers how the integration creates and updates Shopware shipping methods from iPaaS.com data. When an iPaaS.com shipping method is transferred to a Shopware subscription, the integration builds a Shopware shipping method record from the mapped fields and creates it, or updates the matching record when one already exists. The single Add/Update Shopware Shipping Method FROM iPaaS.com collection carries the shipping method name and description, sets the Shopware tax type from an iPaaS.com custom field, resolves the required delivery time from its Shopware name, derives the technical name, and sets whether the shipping method is active.
ID Format
Manual Sync ID Format
A shipping method transfer is driven by the iPaaS.com shipping method. A Manual Sync targets a shipping method by its iPaaS.com record identifier (for example, 5193), and the integration applies the mapped fields to create a new Shopware shipping method or update the matching record.
External ID Format
When the collection creates a Shopware shipping method, the generated Shopware shipping method identifier (for example, 7b3e1c4d8a2f4e6b9c0d5a1f2e3b4c5d) is saved as the external id against the iPaaS.com shipping method. A later transfer reads that stored external id, or matches by technical name when no link exists yet, to target the existing shipping method rather than creating a duplicate.
Deleted Record Support
There is no dedicated Delete collection for shipping methods in this family, so deletions are not propagated by default. When an iPaaS.com shipping method is removed, the integration does not delete the linked Shopware shipping method automatically. Subscribers or their MiSP who need a shipping method removed from Shopware should handle that directly in the Shopware admin.
Custom Field Support
This collection reads the Shopware tax type from an iPaaS.com custom field named exactly Shopware Tax Type. The exact custom field name is what lets the tax type round-trip between the two systems: the opposite-direction Add/Update Shopware Shipping Method TO iPaaS.com collection writes the Shopware tax type into the Shopware Tax Type custom field, and this collection reads the same custom field back into Shopware. Subscribers or their MiSP should keep the custom field name exact in both directions so the value resolves correctly on the way back in.
Mapping Collection Status
Add/Update Shopware Shipping Method FROM iPaaS.com: Enabled.
Trigger Events
A transfer runs when an iPaaS.com shipping method transfer targets this Shopware subscription.
The collection can also be run on demand through a Manual Sync against the iPaaS.com shipping method.
Duplicate or Conflicting Mappings
This collection creates or updates shipping methods in Shopware from iPaaS.com data. The following collection operates on shipping method records in the opposite direction:
Add/Update Shopware Shipping Method TO iPaaS.com: Transfers shipping methods from Shopware to iPaaS.com.
Important: Before enabling this inbound "FROM iPaaS.com" collection alongside the opposite-direction "TO iPaaS.com" collection, review and customize your mapping collection filters to prevent circular updates. Define clearly which system is the source of truth for shipping method data. If both directions are active with default mappings, a shipping method updated in one system can echo back to the other and changes may propagate back and forth between systems. Subscribers or their MiSP should scope filters or disable one direction if they do not want bidirectional sync.
When a shipping method is transferred and is not already linked to a Shopware shipping method, the integration looks for an existing Shopware shipping method with the same technical name and links it by external id instead of creating a duplicate. Keep technical names accurate so this matching dedupes records as intended.
Shopware Caveats
Named records must already exist: The delivery time is resolved by name at transfer time and is not created automatically. Confirm the referenced delivery time exists in Shopware before enabling the collection.
Required fields for creation: Shopware requires a Name, a DeliveryTimeId, and a TechnicalName to create a shipping method. If any required field is missing or its lookup resolves to nothing, the record is rejected and an error is recorded in Dashboard / Integration Monitoring / Error Logs.
Fixed tax type requires a tax ID: When the tax type resolves to fixed, a tax ID must also be supplied for the shipping method, or Shopware returns an error. The accepted tax types are auto, highest, and fixed.
iPaaS.com Caveats
Duplicate prevention by technical name: When a shipping method is transferred and is not already linked to a Shopware shipping method, the integration looks for an existing Shopware shipping method with the same technical name and links it by external id instead of creating a duplicate. An unrelated record is not created on the fly. Keep technical names accurate so this matching works as intended.
This collection transfers shipping method data into Shopware. When the opposite-direction Add/Update Shopware Shipping Method TO iPaaS.com collection is also enabled, define which system owns shipping method data so updates do not circulate between the two platforms.
Subscribers or their MiSP should stagger large manual jobs and rely on the configured throttle limits when transferring many shipping methods at once.
Setup Requirements
For automatic transfer, the iPaaS.com shipping method Outbound Data Flows must be configured to target this Shopware subscription so that shipping method creates and updates reach the Add/Update Shopware Shipping Method FROM iPaaS.com collection. With the data flow in place, no manual intervention is required for routine transfers; a Manual Sync remains available for on-demand runs and re-processing.
Integration Flow
An iPaaS.com shipping method is created or updated, or a Manual Sync is triggered against the shipping method.
The integration fetches the iPaaS.com shipping method record and applies the mapped fields.
The delivery time is resolved from its Shopware name through the GetDeliveryTimeIdByName lookup, and the technical name is derived from the shipping method name.
The tax type is read from the iPaaS.com Shopware Tax Type custom field, and the active flag is applied.
If no link exists yet, the integration matches an existing Shopware shipping method by technical name; otherwise it creates a new Shopware shipping method record.
On success, the Shopware shipping method identifier is saved as the external id against the iPaaS.com shipping method so a later transfer targets the same record rather than creating a duplicate.
Mappings
Add/Update Shopware Shipping Method FROM iPaaS.com
Description. Creates or updates a Shopware shipping method from an iPaaS.com shipping method and links it back to the originating iPaaS.com record.
Mapping Type | Source Field (iPaaS.com) | Destination Field (Shopware) | Description |
Field | Name | Name | Required — the shipping method name carried from iPaaS.com; Shopware requires a name to create a shipping method, a transfer that arrives without one is rejected, and the name is also the basis for the derived technical name. |
Field | Shopware Tax Type (custom field) | TaxType | Optional — sets the Shopware tax type, read from the iPaaS.com custom field named exactly Shopware Tax Type so the value round-trips; accepted values are auto, highest, and fixed, and a fixed tax type also requires a tax ID on the shipping method. |
Field | Description | Description | Optional — the shipping method description carried from iPaaS.com; transferred empty when the iPaaS.com record has none. |
Dynamic Formula | Resolve delivery time by name | DeliveryTimeId | Required — resolves the Shopware delivery time from its name through the GetDeliveryTimeIdByName lookup; the named delivery time must already exist in Shopware, and if it is not found the lookup resolves to nothing and the transfer fails. Placeholder value — replace during implementation: |
Dynamic Formula |
| Active | Recommended — sets the shipping method active; supplied as a static true in the default template so the created or updated shipping method is active. When this field is not mapped, Shopware defaults it to inactive; return |
Dynamic Formula |
| TechnicalName | Required — derives the Shopware technical name from the shipping method name in lower case; the technical name is required to create the record and is the value the integration uses to match an incoming shipping method to an existing Shopware shipping method when no link exists yet. |
return await GetDeliveryTimeIdByName("1-2 Wochen");Error Handling
"Required field missing or lookup resolved to nothing": occurs when Name, DeliveryTimeId, or TechnicalName is absent or the delivery-time lookup returns nothing, so Shopware cannot create the shipping method. Resolution: ensure the shipping method has a name and that the referenced delivery time name exists in Shopware before transferring.
"Delivery time not found": occurs when the name passed to the GetDeliveryTimeIdByName lookup does not match any Shopware delivery time, so the required value resolves to nothing and the transfer fails. Resolution: replace the example name with a delivery time name that exists in the target store, found under Settings > Delivery Times in the Shopware admin.
"Fixed tax type requires a tax ID": occurs when the tax type resolves to fixed but no tax ID is supplied for the shipping method. Resolution: supply a tax ID, or use the auto or highest tax type instead.
"Shopware API temporarily unavailable": occurs when Shopware cannot be reached at transfer time, causing the transfer to fail. Resolution: retry by triggering a new transfer from iPaaS.com.
All errors surface in Dashboard / Integration Monitoring / Error Logs.
Testing & Validation
Test Scenarios
Create a new iPaaS.com shipping method with a name and a valid delivery time name and transfer it; confirm a new Shopware shipping method is created with the matching name, description, tax type, and active state.
Transfer an iPaaS.com shipping method whose technical name matches an existing Shopware shipping method that is not yet linked; confirm the existing Shopware record is matched and updated rather than duplicated.
Transfer a shipping method with no name; confirm the record is rejected and an error appears in Dashboard / Integration Monitoring / Error Logs.
Transfer a shipping method whose delivery time name does not exist in Shopware; confirm the required lookup resolves to nothing and the transfer fails with an error in Dashboard / Integration Monitoring / Error Logs.
Transfer a shipping method with the fixed tax type set through the Shopware Tax Type custom field but no tax ID; confirm Shopware returns an error.
Run a Manual Sync against an iPaaS.com shipping method by its record identifier and confirm the collection processes it.
Validation Checklist
The Shopware shipping method name matches the iPaaS.com shipping method name after a transfer.
The technical name is the lower-case form of the name and is used to match an existing Shopware shipping method when no link exists yet.
The delivery time resolves to an existing Shopware delivery time, and the example name
"1-2 Wochen"has been replaced with a name that exists in the target store before production use.The tax type read from the Shopware Tax Type custom field matches the value written by the opposite-direction TO collection.
A newly created Shopware shipping method carries a generated identifier and is linked back to the iPaaS.com shipping method.
The active flag reflects the configured formula value (active by default, inactive if changed to
false).Required-field and missing-lookup failures are recorded in Dashboard / Integration Monitoring / Error Logs.
Additional Notes
These limitations are inherent to the current design of the integration and the capabilities of the Shopware API, and they apply to all subscribers at the time this documentation was written.
The delivery time is resolved to a Shopware record at transfer time. If the referenced delivery time does not exist in Shopware, the value resolves to nothing and shipping method creation fails. Confirm the referenced delivery time exists before enabling the collection.
There is no dedicated Delete collection for shipping methods; deletions are not propagated to Shopware automatically.
If the Shopware API is temporarily unavailable when a transfer is triggered, the transfer fails and an error appears in Dashboard / Integration Monitoring / Error Logs. The record can be retried by triggering a new transfer from iPaaS.com.