Before you begin, obtain your API token from Orderful.
Log in to your Orderful account.
In the upper right, click your profile icon and then select Settings.
On the Account Settings page, click API Credentials.
Click Show to reveal the token, then click the copy icon next to the token to copy it to your clipboard.
Continue to the next section to complete the installation.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Orderful integration tile.
On the Subscription Detail page, click the Subscribe button.
Enter a name for the subscription and select a version. Use any relevant, unique name within the company where the subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Orderful - Release
Leave Create Default Mappings selected (recommended). If you prefer to build all mappings yourself, clear this checkbox.
Provide the API URL for your Orderful instance.
Test/Sandbox:
https://api.orderful.com/v3/Production: provided by Orderful for your organization.
Enter the API Key you copied from Orderful.
(Optional) Set the Transaction Tracking Match Method, which controls how ship-notice (856) tracking is matched to a transaction:
ShipmentIdentification — match on the shipment identification.
PurchaseOrderNumber — match on the purchase order number (the default if left blank).
Fallback — try the purchase order number first, then the shipment identification.
Enter the API Throttle Limit — the maximum number of API requests allowed within the throttle window.
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds — the time window over which the throttle limit is measured.
Default: 60
Enter the Concurrent Connections — the maximum number of simultaneous API connections.
Default: 10
Enter the Concurrent Batch Executions — the maximum number of simultaneous batch executions.
Default: 10
Click Apply to save the settings.
For an ongoing reference to these settings (including how to rotate the API key), see the Orderful Connections and Settings article.
Post-Installation Verification
After completing the installation, verify it with these checks:
Data Sync Test
Run a sample inbound transfer (To iPaaS.com) — for example, sync an Orderful transaction by its ID from the Manual Sync page.
Run a sample outbound transfer (From iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate field mappings and review the integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or search the documentation.
Documentation: https://support.ipaas.com/en/
Support Portal: click the Help and Support button at the lower right of any iPaaS.com page.
Contact: https://ipaas.com/contact-us/
Related Documents