See what the ShipHero integration can do →
Before You Begin
Before installing the integration, 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.
The username and password the integration will use to authenticate to ShipHero. ShipHero recommends using dedicated credentials for API access.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the ShipHero integration title, then click Subscribe.
Enter a Name for the subscription and select a Version. The name can be any relevant, unique subscription name within your company (for example,
ShipHero - Production).Select Create Default Mappings (recommended). If you prefer to create all mappings from scratch, leave this unchecked.
On the subscription settings page, complete the ShipHero fields:
API URL: the base URL of the ShipHero public API. ShipHero provides a single production API environment —
https://public-api.shiphero.com— and does not offer a separate sandbox or test API URL.Username and Password: the credentials for your ShipHero account (see Authentication Configuration below).
Skip Parent Product: determines how variant products are created in ShipHero. Set to True so that only the variant itself is created as a product in ShipHero; set to False (or leave blank) to create both the parent product and the variant.
Recommended: True when you want variants to exist independently as products; False or blank when a parent-child structure must be preserved.
Variant Inventory Poll Batch Size Time Span: the time span, in hours, covered by each polling batch during variant inventory synchronization. Dividing large date ranges into smaller windows helps performance and avoids exceeding ShipHero's API limits.
Recommended values — Initial Setup: 6 hours; Ongoing Operations: 12 hours; High Volume: 24 hours. Example: set to 6, and each batch retrieves inventory within a 6-hour window until the full range is processed.
Variant Inventory Poll Search Days: how many days before the current date the first polling run looks back when fetching records.
Recommended values — Initial Setup: 3 days; Ongoing Operations: 5 days; High Volume: 7 days. Example: with today as October 21, 2025 and the value set to 3, polling starts from October 18, 2025.
Confirm the API throttle fields, which are pre-populated with recommended values and keep the integration within ShipHero's credit-based API limits:
API Throttle Limit: recommended values are Initial Setup 5, Ongoing Operations 500, High Volume 500.
API Throttle Seconds: 60.
Concurrent Connections: 10.
Concurrent Batch Executions: 10.
Click Apply to save the subscription settings.
Authentication Configuration
The integration authenticates to ShipHero with a username and password.
Username: your ShipHero account username (email) used for API access.
Location: your ShipHero account. ShipHero recommends dedicated API credentials — see the ShipHero Developer documentation.
Password: the password for that ShipHero account.
The integration exchanges these credentials with ShipHero for an access token and a refresh token, then uses the access token for all API calls. It renews the token automatically, 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.
Post-Installation Verification
Connection: After entering credentials and clicking Apply, confirm the subscription saves without an authentication error.
Data sync: From the iPaaS.com Manual Sync page, sync a single record (for example, a product by its iPaaS.com record ID) and confirm it appears in ShipHero.
Inventory/shipments: Confirm that inventory and shipment updates from ShipHero appear against the matching iPaaS.com records once the corresponding products, locations, and orders exist in iPaaS.com.
Error Messages
If a transfer reports an error, the message appears in Dashboard > Integration Monitoring > Error Logs. For a catalog of the messages you may see and how to resolve them, see the ShipHero Error Messages article in the iPaaS.com Help Center.
Support and Troubleshooting
iPaaS.com API documentation: https://support.ipaas.com/en/articles/10280417-api-introduction
iPaaS.com Support Portal: https://support.ipaas.com/en/
Contact iPaaS.com: https://ipaas.com/contact-us/ (or email support@ipaas.com)
ShipHero developer documentation: https://developer.shiphero.com/
Related Documents