Summary
This mapping collection transfers Shipping Method records from Shopware to iPaaS.com. The standalone Add/Update Shopware Shipping Method TO iPaaS.com collection creates and updates shipping method records when triggered by Shopware webhook events or by Manual Sync. It maps the shipping method Name and Description to the standard iPaaS.com Shipping Method fields and writes the Shopware tax type into a custom field named Shopware Tax Type so the value is available for the opposite-direction transfer.
ID Format
Manual Sync ID Format
Shipping methods are transferred from the iPaaS.com Manual Sync page by entering the Shopware shipping method ID in the input field to transfer a specific shipping method. A concrete example shipping method ID is 01915630e5db7214ab1ab2dc71608955.
External ID Format
The integration links each transferred shipping method to the originating Shopware shipping method by its external ID. On subsequent transfers, the integration matches an incoming shipping method to the existing iPaaS.com Shipping Method by that linked external ID and updates it, rather than creating a duplicate. The primary human-readable identifier in iPaaS.com is the shipping method Name.
Deleted Record Support
This collection does not include a Delete collection. Shipping method deletions in Shopware are not propagated to iPaaS.com by default. Removing a shipping method in Shopware leaves the corresponding iPaaS.com Shipping Method record in place; subscribers or their MiSP who need the iPaaS.com record removed should remove it directly in iPaaS.com.
Custom Field Support
This collection stores the Shopware shipping method tax type on the iPaaS.com Shipping Method as a custom field. The custom field must be named exactly Shopware Tax Type. This naming convention is what lets the tax type round-trip between the two systems: this collection writes the Shopware tax type into the Shopware Tax Type custom field, and the opposite-direction Add/Update Shopware Shipping Method FROM iPaaS.com collection reads the same custom field back into Shopware. Custom field values are written and read using the integration's custom field helpers (GetCustomFieldValue and GetValueFromCustomField). Subscribers or their MiSP should keep the custom field name exact in both directions; a mismatch in either direction breaks the round-trip.
Mapping Collection Status
This collection is Enabled.
Trigger Events
The collection runs when a subscribed Shopware shipping method event fires (Automatic transfer): shippingmethod/created when a shipping method is created, and shippingmethod/updated when a shipping method is updated.
The collection also runs when a shipping method is transferred from the iPaaS.com Manual Sync page (Manual transfer).
Duplicate or Conflicting Mappings
This collection transfers Shipping Methods from Shopware to iPaaS.com. The following collection operates on Shipping Method records in the opposite direction and should be reviewed before enabling both directions:
Add/Update Shopware Shipping Method FROM iPaaS.com: Creates or updates shipping methods in Shopware from iPaaS.com data — the inbound counterpart of this collection. It reads the Shopware Tax Type custom field that this collection writes.
Important: Before enabling this outbound collection alongside the opposite-direction Add/Update Shopware Shipping Method FROM 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 should scope filters or disable one direction if they do not want bidirectional sync.
Unmapped Field Overwrite Risk
The iPaaS.com API performs a full record replace when updating Shipping Method records, and this collection handles both Add and Update. The standard iPaaS.com Shipping Method fields are Name and Description, and both are already mapped in this collection (the Shopware Tax Type custom field is separate and is not a standard field), so there are no unmapped standard fields to be overwritten by the default template. If subscribers or their MiSP add a mapping for any further standard Shipping Method field, keep all standard fields mapped, and in an Update scenario preserve any value that originates in iPaaS.com by adding a Dynamic Formula mapping that uses the DestinationValue function to carry the existing value forward.
Shopware Caveats
Webhook workflow actions require Enterprise Shopware: The automatic-transfer workflows described under Setup Requirements can only be created on Enterprise editions of Shopware. Subscribers on other editions should rely on Manual Sync.
iPaaS.com Caveats
The iPaaS.com Shipping Method API does not mark any field as required. The name is the primary human-readable identifier, so subscribers should ensure each Shopware shipping method has a name before transfer even though it is not strictly enforced.
The integration matches an incoming shipping method to an existing iPaaS.com Shipping Method by its linked external ID and updates it, rather than creating a duplicate. When the opposite-direction Add/Update Shopware Shipping Method FROM iPaaS.com collection is also enabled, define which system owns shipping method data so updates do not circulate between the two platforms.
Subscribers should stagger large manual jobs and rely on the configured throttle limits for the subscription when transferring shipping methods in bulk.
Setup Requirements
For Automatic transfer, subscribers or their MiSP must subscribe to the relevant Shopware shipping method events on the Inbound Data Flows (External Webhooks) page of the Shopware subscription in iPaaS.com. Webhooks do not activate automatically — the relevant events must be subscribed before automatic transfers occur. Subscribing creates a workflow in Shopware that sends a webhook to iPaaS.com after the corresponding event; clearing the Inbound Data Flow toggle removes that workflow. Webhook workflow actions are only available in Enterprise editions of Shopware; on non-Enterprise editions, use Manual Sync instead.
Integration Flow
A subscribed Shopware shipping method event fires — shippingmethod/created or shippingmethod/updated (Automatic) — or a subscriber enters the Shopware shipping method ID on the iPaaS.com Manual Sync page (Manual).
iPaaS.com receives the trigger and retrieves the full shipping method record from Shopware.
The record runs through this collection. The shipping method Name and Description are mapped to the standard iPaaS.com Shipping Method fields, and the Shopware tax type is written to the Shopware Tax Type custom field.
The integration resolves the external-id link to the originating Shopware shipping method. If a matching iPaaS.com Shipping Method already exists for that link, it is updated; otherwise a new record is created.
The transferred shipping method is available in iPaaS.com, and the Shopware Tax Type custom field carries the tax type for the opposite-direction transfer.
Mappings
Add/Update Shopware Shipping Method TO iPaaS.com
Description: Transfers the Shopware shipping method's name and description to the standard iPaaS.com Shipping Method fields and writes the Shopware tax type to the Shopware Tax Type custom field.
Mapping Type | Source Field (Shopware) | Destination Field (iPaaS.com) | Description |
Field | Name | Name | recommended — maps the Shopware shipping method name to the iPaaS.com Shipping Method name. The API does not mark it as required, but it is the primary human-readable identifier, so subscribers should ensure each Shopware shipping method has a name before transfer. |
Dynamic Formula | Null-safe description passthrough | Description | optional — maps the Shopware shipping method description; the formula returns the description when present and an empty string when missing or blank, so a blank value does not cause an error during transfer. |
Field | TaxType | Shopware Tax Type | optional — writes the Shopware shipping method tax type into the Shopware Tax Type custom field (not a standard field). The name must match exactly so the value round-trips with the opposite-direction FROM collection. |
// Description
if(Description!=null && Description!=""){
return Description;
}
return string.Empty;Error Handling
Errors surface in Dashboard / Integration Monitoring / Error Logs.
Shopware API temporarily unavailable: If the Shopware API is unavailable when a transfer is triggered, the transfer fails and an error appears in the error logs. Resolution: retry the record by triggering a new webhook event or by using Manual Sync.
Testing & Validation
Test Scenarios
Create a new shipping method in Shopware and confirm it transfers to iPaaS.com with the Name and Description populated and the Shopware Tax Type custom field carrying the tax type.
Update an existing shipping method's name or description in Shopware and confirm the matching iPaaS.com Shipping Method is updated rather than duplicated.
Transfer a shipping method whose Shopware description is empty and confirm the iPaaS.com Description is blank with no transfer error.
Use Manual Sync with the Shopware shipping method ID and confirm the shipping method transfers.
Confirm the Shopware Tax Type custom field is named exactly Shopware Tax Type and that the value round-trips when the opposite-direction Add/Update Shopware Shipping Method FROM iPaaS.com collection reads it back into Shopware.
Validation Checklist
The iPaaS.com Shipping Method Name matches the Shopware shipping method name.
The Description matches the Shopware description, and is blank (not errored) when the Shopware description is empty.
The Shopware Tax Type custom field is present, named exactly, and carries the Shopware tax type.
On a second transfer of the same shipping method, the existing iPaaS.com record is updated via its external-id link rather than duplicated.
For Update transfers, any additional standard field a subscriber maps is preserved using the DestinationValue technique where required.
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 iPaaS.com Shipping Method API does not mark any field as required; the name is treated as recommended because it is the primary human-readable identifier.