This article walks you through installing and configuring the ShipBob integration on iPaaS.com. Follow the sections in order: gather what you need from ShipBob, subscribe to the integration, complete the subscription settings, authorize iPaaS.com to connect to ShipBob, and verify the connection with a Manual Sync.
Before You Begin
Before you start, make sure you have the following ready.
A ShipBob account with permission to manage integrations and generate credentials.
Your ShipBob API URL. This is the base address of your ShipBob instance and is required during setup. It is instance-specific, so confirm the exact value for your account with ShipBob before you begin.
Your ShipBob channel identifier. Creating orders in ShipBob requires a channel identifier that ShipBob does not display in its interface. You obtain it through the ShipBob API, and your implementation partner or MiSP (Managed Integration Service Provider) can help retrieve it. You do not need it to complete authorization, but you will need it in the order mappings before enabling the order flow. See the ShipBob Known Limitations article for details.
Obtaining a ShipBob Personal Access Token (optional)
A ShipBob Personal Access Token is optional for this integration — the primary connection is established by authorizing with ShipBob (described later in this article). If your implementation calls for a Personal Access Token, generate one in ShipBob as follows.
In ShipBob, click Integrations > API Tokens.
On the Personal Access Token page, click Generate New Token. The ShipBob Personal Access Token (PAT) is used for authenticating API requests, allowing your system to securely access and manage your ShipBob data such as orders, inventory, and shipments.
Enter a Token Name and a Description, and then click Generate Token. ShipBob displays a confirmation message and sends an email to the account Owner.
Click Copy to copy the token, and save it in a secure location.
Select I have copied the token and then click Confirm and Close.
You can now continue with the installation.
Integration Setup
Subscribe to the ShipBob integration from the iPaaS.com marketplace.
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the ShipBob integration tile.
On the Subscription Detail page, click the Subscribe button.
Enter a name for the subscription and select a version. The name can be any relevant, unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: ShipBob - Release
Select Create Default Mappings (recommended).
NOTE: If you prefer to build all mappings from scratch yourself, leave this box unchecked.
Click Apply to create the subscription.
After the subscription is created, complete the subscription settings described in the next section.
Additional Configuration — Subscription Settings
Open the subscription you just created and complete the following settings. Field names below match the iPaaS.com subscription settings exactly.
Setting | Required | Description |
API URL | Required | The base address of your ShipBob instance. This value is instance-specific and differs for every account — enter the exact value provided by ShipBob. |
Auth API Url | Required | The address iPaaS.com uses to authorize with ShipBob during the authentication step. Enter the value provided for your account. |
Personal Access Token | Optional | A ShipBob Personal Access Token, if your implementation uses one. The primary connection is established through authorization, so this can be left blank in most setups. |
Inventory Match Method | Optional | Defines how a product is matched when inventory records are captured. If set to Reference, the product is matched by its Reference ID. If set to sku, the product is matched by its SKU. If left blank or set to any other value, the product is matched by Name. |
After entering the settings, click Apply to save them.
Authentication Configuration
The ShipBob integration connects using OAuth 2.0. You authorize iPaaS.com once through ShipBob's login and consent screens; iPaaS.com then receives an access token and a refresh token and keeps the connection alive automatically by refreshing the access token as it expires. You do not manage tokens by hand after authorization is complete.
To authorize the connection:
Open the ShipBob subscription you created.
Click the Authentication icon in the top toolbar.
A new browser window opens. Click Yes, Allow to give the application permission to continue.
In the ShipBob Login window, enter your ShipBob account credentials.
In the channel selection window, select an existing channel or create a new channel, and approve all requested permissions.
Click Allow & Install.
On the Authorization page, click Close Page.
Refresh your iPaaS.com subscription. The access token and refresh token are now present on the subscription. The access token expires after a period of time; iPaaS.com uses the refresh token to regenerate it automatically, so no further action is needed.
If authorization does not complete, confirm that the API URL and Auth API Url settings are correct and that your ShipBob account has permission to install integrations, then retry the steps above.
Post-Installation Verification
After installation and authorization, verify the connection with a Manual Sync.
Open the ShipBob subscription.
Choose one of the record types captured from ShipBob — for example a location or a shipping method — and run a Manual Sync for a single record.
Confirm that the record is retrieved into iPaaS.com without error.
Review the iPaaS.com Dashboard under Integration Monitoring and Error Logs to confirm there are no errors from the sync.
A successful Manual Sync confirms that the subscription settings and the authorization are working. Before enabling the order flow, make sure your ShipBob channel identifier is set in the order mappings (see Before You Begin and the ShipBob Known Limitations article).
Support and Troubleshooting
Documentation: Search our documentation using the search bar at the top of this article.
Support Portal: Click the Help and Support button at the lower right of the screen.
Contact Information: Contact us for more information.