Integrate iPaaS.com with ShipHero to enable seamless data synchronization for products, product variants, kits, inventory, sales orders, and shipments.
How to Connect
Prerequisites
Before configuring the integration in iPaaS.com, set up API access in ShipHero:
A ShipHero account with API access. ShipHero exposes a public GraphQL API; see the ShipHero Developer documentation for details on API access and credentials.
API credentials (a username and password) that the integration will use to authenticate to ShipHero. ShipHero recommends using dedicated credentials for API access rather than a personal login.
Configuration Details
You will enter the following values when configuring the subscription in iPaaS.com:
API URL: the base URL of the ShipHero public API the integration connects to. Example:
https://public-api.shiphero.com.Username: the ShipHero account username (email) used for API access.
Password: the password for that ShipHero account.
Configure Subscription Settings
On the subscription's settings page in iPaaS.com, complete the fields below.
Field | Description | Required | Example |
API URL | The base URL of the ShipHero public API. | Yes |
|
Username | The ShipHero account username (email) used for API access. | Yes |
|
Password | The password for the ShipHero account. | Yes | (your ShipHero password) |
Variant Inventory Poll Search Days | How many days back the variant-inventory poll looks for changes when it runs. Leave blank to use the default of 5 days. | No |
|
Variant Inventory Poll Batch Size Time Span | The size, in hours, of each time window the variant-inventory poll processes per batch. Leave blank to use the default of 12. | No |
|
Skip Parent Product | When set to True, the integration does not transfer the parent product as part of a product transfer. When False (the default), the parent product is included. | No |
|
API Throttle Limit | The maximum number of calls the integration makes to ShipHero within the throttle window. | No |
|
API Throttle Seconds | The length, in seconds, of the throttle window. | No |
|
Concurrent Connections | The maximum number of simultaneous connections the integration opens to ShipHero. | No |
|
Concurrent Batch Executions | The maximum number of transfer batches the integration processes at the same time. | No |
|
Authentication Methods
ShipHero uses token-based authentication. The integration signs in with the Username and Password you provide: it exchanges those credentials with ShipHero for an access token and a refresh token, then uses the access token to make API calls. The integration stores the refresh token and renews the access token automatically as it expires, so you do not need to re-enter credentials for ongoing synchronization. If you change the ShipHero account password, update the Password field so the integration can re-authenticate.
Initialization Support
Currently, initialization (a bulk import of existing data when the subscription is first connected) is not supported for ShipHero in iPaaS.com. Data synchronization is configured through the mapping collections and runs on an ongoing basis — ShipHero delivers inventory and shipment updates to iPaaS.com in real time, and products, kits, and sales orders are transferred from iPaaS.com as they are added or updated. Records can also be synced on demand from the iPaaS.com Manual Sync page.
Throttling
The integration's throttle fields — API Throttle Limit, API Throttle Seconds, Concurrent Connections, and Concurrent Batch Executions — are pre-populated with recommended values when the subscription is created and control how frequently the integration calls ShipHero. ShipHero's API is credit-based, so these values keep the integration within ShipHero's usage limits; raise or lower them only if needed for your volume. For details on adjusting these fields, see the Subscription Configuration – Edit article in the iPaaS.com Help Center.
Related Documents