Contents
Summary
This documentation covers the collection that brings ShipStation carriers and shipping services into iPaaS.com as Shipping Method records. Data flows from ShipStation into iPaaS.com (inbound), with each ShipStation carrier or service becoming an iPaaS.com Shipping Method that subscribers or their MiSP can reference elsewhere in their iPaaS.com configuration. The collection transfers through Initialization, a one-time bulk pull of all carriers and services, and through Manual Sync on demand.
ID Format
Shipping Method records are identified by the carrier or service name supplied by ShipStation. Subscribers do not assign an identifier; the name carried from ShipStation serves as the record identifier.
Manual Sync ID Format: Subscribers select the methods to transfer from within iPaaS.com rather than entering an identifier value. The name carried from ShipStation identifies the resulting record.
External ID Format: The carrier or service name supplied by ShipStation (for example, a value such as USPS First Class Mail).
Deleted Record Support
Not implemented. This collection does not remove Shipping Method records from iPaaS.com. Carriers or services removed in ShipStation are not deleted from iPaaS.com by this collection, deletions do not propagate, and delete mappings are not part of the default templates.
Custom Field Support
Not applicable. This collection maps to standard Shipping Method fields only and does not populate any iPaaS.com custom field.
Mapping Collection Status
Enabled. No filter is applied, so all ShipStation carriers and shipping services are processed.
Trigger Events: This collection transfers through Initialization and Manual Sync. There is no webhook or polling trigger for shipping methods. Initialization performs a one-time bulk pull of all ShipStation carriers and services, typically run when the integration is first set up, and Manual Sync lets subscribers or their MiSP run a transfer on demand.
Duplicate or Conflicting Mappings
None. This is the only collection that brings ShipStation shipping methods into iPaaS.com, and there is one collection per entity and direction. No collision handling is implemented.
Supported Child Collections
None. This is a standalone collection and is not a child of any other collection, nor does it have child collections of its own.
System Caveats
ShipStation Caveats
The set of methods that transfer reflects the carriers and services configured in the connected ShipStation account. There are no caveats beyond this standard behavior. The connection test does not validate credentials, so subscribers should verify the connection by running a test transfer.
iPaaS.com Caveats
The integration does not automatically transfer dependent records. A referenced record must already exist in iPaaS.com before another record can point to it. Destination requiredness is defined by iPaaS.com, so subscribers should validate the field requirements in a staging environment before relying on them in production.
Setup Requirements
To bring shipping methods into iPaaS.com, run Initialization once during setup so the full set of ShipStation carriers and services is available, then use Manual Sync to bring across later additions or changes. Valid ShipStation API credentials must be configured for the connected account so the integration can retrieve the available carriers and services. For account connection and field configuration details, refer to the ShipStation Installation Instructions article and the ShipStation Connections and Settings article rather than duplicating those steps here.
Integration Flow
The integration retrieves the available carriers and shipping services from the connected ShipStation account.
Each carrier or service is dispatched into iPaaS.com as a Shipping Method record.
Records are added or updated based on the Add/Update sync type, so re-running the transfer refreshes existing methods rather than creating duplicates.
Subscribers or their MiSP run Initialization for the initial bulk pull and Manual Sync for later transfers.
Mappings
Add/Update ShipStation Shipping Method TO iPaaS.com
iPaaS.com data type: Shipping Method
This collection brings each ShipStation carrier or shipping service into iPaaS.com as a Shipping Method record.
Mapping Type | Source Field (ShipStation) | Destination Field (iPaaS.com) | Description |
Field | Name | Name | Recommended. Carries the ShipStation carrier or shipping service name into the Shipping Method record. This is the human-readable label subscribers see when selecting a shipping method in iPaaS.com. The record is identified primarily by its name, so a method without a name is difficult to reference, although the iPaaS.com record does not strictly enforce it. No subscriber configuration is needed; the value is brought across as supplied by ShipStation. |
Field | CarrierCode | Description | Recommended. Carries the ShipStation carrier code into the Description field of the Shipping Method record, providing additional context about which carrier the method belongs to. This detail helps subscribers distinguish methods but is not required for the record to be created. No subscriber configuration is needed; the value is brought across as supplied by ShipStation. |
Error Handling
For the list of error messages this integration can return and what each one means, refer to the ShipStation Error Messages article.
Validation Rules
None. This collection applies no mapping filter and no field-level validation rules. Destination requiredness is defined by iPaaS.com.
Testing and Validation
Test Scenarios
Run Initialization on a newly configured integration and confirm that the full set of ShipStation carriers and services appears as Shipping Method records in iPaaS.com.
Add or change a carrier or service in ShipStation, run Manual Sync, and confirm the corresponding Shipping Method record is created or refreshed without producing a duplicate.
Open a transferred Shipping Method record and confirm the Name reflects the ShipStation carrier or service name and the Description reflects the ShipStation carrier code.
Validation Checklist
Initialization completes and brings across the expected carriers and services.
Each Shipping Method record shows the correct Name from ShipStation.
Each Shipping Method record shows the correct Description from the ShipStation carrier code.
Re-running the transfer updates existing records rather than creating duplicates.
The ShipStation account credentials are valid, confirmed by a successful test transfer.
Additional Notes
There is no automatic, scheduled refresh of shipping methods at the time this documentation was written. New or changed ShipStation carriers and services are brought across by running Initialization again or by Manual Sync. Deletion of Shipping Method records is out of scope; methods removed in ShipStation are not removed from iPaaS.com by this collection. For the full list of behaviors that fall outside this integration, refer to the ShipStation Integration Known Limitations article.