Before You Begin
Before you begin, you will need to obtain a Personal Access Token from 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. It allows your system to securely access and manage your ShipBob data (orders, inventory, shipments).
Enter 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. 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.
Installation Instructions for Integration Setup
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 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: ShipBob – Release
Select Create Default Mappings (recommended).
NOTE: If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.Provide the API URL endpoint for your ShipBob instance. The ShipBob API URL is instance based. It is different for all instances.
Set the Inventory Match Method which defines the method used to fetch a product.
If Inventory Match Method is set to Reference, the product will be fetched using its Reference ID.
If set to sku, the product will be fetched using its SKU.
If left null, empty, or any other value, the product will be searched by Name.
Authorization Initialization
To generate an access token for communicating with ShipBob via API, follow these steps:
Go to the ShipBob Subscription that was created
Click the Authentication icon found in the top toolbar.
A new browser window opens. Click Yes, Allow to give the application permission.In the ShipBob Login window, enter your account credentials.
In the Channel Selection window, select an existing channel or create a new channel and approve all permissions.
Click Allow & Install.
On the Authorization page, click Close Page.
Refresh your iPaaS.com subscription. The Refresh and Access tokens should be present. The ShipBob Access Token expires after some time and is deleted from subscription persistent data. The Refresh Token regenerates the Access Token.
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 ShipBob 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, verify the integration by performing the following:
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.
Support and Troubleshooting
Documentation: Search our documentation at the top of this article,.
Support Portal: Click the Help and Support button at the lower right.
Contact Information: Contact us for more information.