Before You Begin
Before you begin, you must obtain an API Key and API Secret from Zuper.
The API Key must be created in the Zuper portal. Follow these steps:
Log in to the Zuper portal.
Go to Settings > Account Settings > API Key.
If you will use an existing key, click View Key for the API Key Name.
If you need to create a new key, click New API Key, type an API Key Name, and click Create.Copy the key. You will need it to configure your subscription.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Zuper integration tile.
On the Subscription Detail page, click the Subscribe button.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: ShipStation– Production
Select Create Default Mappings (recommended). If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.
Enter the API Key you saved from Zuper.
Provide the API URL endpoint for your Zuper instance. For example,
Environment URLs:
Test/Sandbox: https://us-west-1c.zuperpro.com/api
Production: N/A
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that ShipStation can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Data Sync Test
Initiate a sample data pull. (To iPaaS.com).
Initiate a sample data push. (From iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Common Issues and Solutions
Invalid API URL
Description: Using a fixed URL instead of your region-specific one.
Resolution: Call the Config API (https://accounts.zuperpro.com/api/config) with your company_name to get the correct dc_api_url.
Authentication Failures
Description: API requests return 401 Unauthorized.
Resolution: Use the correct OAuth 2.0 access token and refresh it before it expires.
Insufficient Permissions
Description: User cannot create or update entities.
Resolution: Assign proper roles (Admin, Manager, Dispatcher) in Zuper.
Invalid or Missing IDs
Description: Requests fail because referenced objects (customer, location, product) don’t exist.
Resolution: Fetch and validate IDs with GET endpoints before using them.
Incorrect Date Format
Description: API rejects start_date or end_date values.
Resolution: Always use ISO 8601 format.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.