Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.

Click the ShipHawk integration tile.

Click Subscribe.

Enter a descriptive name for your ShipHawk subscription.
​Format: ShipHawk - [Environment/Purpose]
​Example: ShipHawk - Production

Select Create Default Mappings (recommended).
Note: If you do not want to create default mappings and prefer to create all mappings from scratch, uncheck this box.

Enter the API endpoint for your ShipHawk instance in the API URL field.
​Environment URLs:
​Test/Sandbox: https://{sandbox-prefix}.tms.myshiphawk.com
​Production: https://{your-domain}.tms.myshiphawk.com

Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests.
​Recommended Values:
Initial Setup: 0 (Unlimited)

Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured.
​Default Value: 0 (Unlimited)

Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that iPaaS.com can process for this subscription.
​Default Value: 1
​Range: 1

Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for the ShipHawk integration at one time. (Not currently implemented in this integration.)
​Default Value: 10
​Range: 1–10

Click Apply to save the settings.

Log in to the ShipHawk developer portal:
​https://{sandbox-prefix}.tms.myshiphawk.com/

Navigate to Settings > Developer API.

Click Create API Key.

In the Create API Key dialog box, enter a name for the key.

Click Create API Key to confirm.

Copy the API Key from the confirmation dialog. Store it securely, as it may not be displayed again.

Paste the API Key into the API KEY field on the ShipHawk Subscription Settings page in iPaaS.com.

Connection Test: Navigate to the ShipHawk subscription in iPaaS.com and verify the connection status shows as active.

Data Sync Test: Create a test transaction in iPaaS.com and trigger a manual sync. Verify the order appears in ShipHawk with the correct field mappings.

Functionality Test: Update the test order in iPaaS.com and verify the changes propagate to ShipHawk. Review integration logs in iPaaS.com for any errors.

“Validation failed: order number has already been taken” — ShipHawk rejected order creation because an order with the same order number already exists. If collision handling is enabled in the iPaaS.com mapping collection, the existing order ID is extracted and reused automatically. If not enabled, enable it to prevent duplicate orders.

“X-Api-Key header is missing or invalid” — The API Key in the iPaaS.com Subscription Settings is missing, expired, or incorrect. Generate a new API Key in the ShipHawk developer portal and update the subscription.