Integrate iPaaS.com with Orderful to enable data synchronization for EDI transactions — purchase orders, purchase order acknowledgements, invoices, and ship-notice tracking.
Prerequisites
API URL — the Orderful API base address. For the production environment, use
https://api.orderful.com/v3/.API Key — your Orderful API token. In the Orderful portal, go to the Account icon > Settings > Organization Settings > API Credentials, then use the copy button to copy the API token.
Configuration Details
API Key — the API token copied from the Orderful portal. Used to authenticate every request to Orderful.
API URL — the Orderful API base address for your environment.
Configure Subscription Settings
In iPaaS.com, open the Orderful subscription settings and provide the following:
Field | Description | Required | Example |
Name | A unique name for the subscription. | Yes | Orderful Integration |
Version | The iPaaS.com integration version to use. | Yes | v1.0 |
Transaction Tracking Match Method | How tracking from a ship notice/manifest (856) is matched to an existing transaction. See Optional Configuration below. | No | ShipmentIdentification |
API Key | The Orderful API token used to authenticate. | Yes | Your API token |
API URL | The Orderful API base address. | Yes |
Authentication Methods
Log in to the Orderful portal.
Go to Settings > Organization Settings > API Credentials.
Copy the API Token.
Enter the token in the API Key field of your Orderful subscription in iPaaS.com.
Save the subscription.
The integration sends this API key in the orderful-api-key request header on every call to Orderful; there is no separate sign-in or token-exchange step.
Optional Configuration: Transaction Tracking Match Method
This setting controls how tracking details from an Orderful ship notice/manifest (856) are matched to a transaction in iPaaS.com:
ShipmentIdentification — matches on the ship notice's shipment identification. If no transaction matches, the transfer reports an error.
PurchaseOrderNumber — matches on the purchase order number. This is the default when no match method is selected.
Fallback — tries the purchase order number first, then the shipment identification, and links the first match found (or reports an error if neither matches).
Initialization Support
Currently, initialization (a bulk import of existing data on first connect) is not supported for Orderful in iPaaS.com. Data synchronization and mappings are configured during setup, and records transfer on the polling schedule or on demand through Manual Sync.
Throttling
Throttling protects the Orderful API from being overwhelmed during heavy data transfers. The throttle fields are required but are pre-populated by the integration settings. For details, see the Subscription Configuration – Edit article in the iPaaS.com Help Center.
Related Documents