How to Connect
Prerequisites
Before setting up the ShipBob integration in iPaaS.com, ensure you have the following information:
API URL:
For sandbox environment:
https://sandbox-api.shipbob.com/1.0For production environment:
https://api.shipbob.com/1.0
Inventory Match Method: When adding product inventory to iPaaS.com, select the ShipBob value that will be used to find a matching iPaaS.com SKU. Enter one of the following:
SkuReferenceIdName
This value should also be included when creating orders in ShipBob so their shipments reflect the necessary value (refer to transaction line mappings).
Configure Subscription Settings
Navigate to the ShipBob subscription settings in iPaaS.com and provide the following information:
Field | Description | Required | Example |
Name | A unique name for identifying the ShipBob subscription. | Yes |
|
Version | Specifies the version of the ShipBob API to use. | Yes |
|
API URL | The base URL for the ShipBob instance (sandbox/production) | Yes |
|
Inventory Match Method | The method to match inventory between ShipBob and iPaaS. | Yes |
|
Personal Access Token | Token for accessing the ShipBob API (if applicable). | No |
|
Authentication Methods
Follow these steps to authenticate the ShipBob integration:
Define the API URL:
Navigate to the ShipBob subscription settings in iPaaS.com.
Enter the appropriate API URL for the environment as noted above (sandbox or production).
Save your settings.
Navigate back to the settings page and click on the authenticate button
Authenticate with ShipBob:
A login prompt will appear. Enter your ShipBob credentials (email and password) to proceed.
Select or Create a Sales Channel:
Choose an existing sales channel or create a new one.
Approve all permissions.
Note: iPaaS will only write data (e.g., orders) to the selected channel.
Authorize Integration:
Confirm the connection by clicking Allow & Install.
Upon successful authorization, a confirmation message will appear.
Refresh the iPaaS Subscription:
Refresh your iPaaS.com subscription settings page.
Verify that an API Access Token and Refresh Token are displayed in the settings.
Initialization Support
The following types of data support initialization and can be transferred in bulk:
Location TO iPaaS.com
Location Group TO iPaaS.com
Shipping Method TO iPaaS.com
Throttling
Throttling ensures that Shipbob's API isn’t overwhelmed by excessive API calls, preserving system performance during heavy data transfers.
While the throttling fields are required, the values are pre-populated by the integration settings. For more details, refer to Subscription Configuration – Edit.