How to Connect
Prerequisites
API URL:
For the production environment, use the following:
https://api.orderful.com/v3/
API Key:
In the Orderful portal, navigate to Account Icon > Settings > Organization Settings > API Credentials.
Use the copy button to copy the API Token.
Enter this token into the iPaaS API Key field and save your subscription settings.
Configure Subscription Settings
In iPaaS.com, navigate to the Orderful subscription settings and provide the following information:
Field | Description | Required | Example |
Name | A unique name for the subscription. | Yes | Orderful_Integration |
Version | Specifies the iPaaS.com integration version to use. | Yes | v1.0 |
Transaction Tracking Match Method | Defines the field to search during transaction tracking. | No | ShipmentIdentification |
API Key | Key for API authentication. | Yes | Your_API_Key |
API URL | The endpoint URL for your Orderful API instance. | Yes |
Authentication Method
Log in to the Orderful portal.
Navigate to Settings > Organization Settings > API Credentials.
Copy the API Token.
Enter this token in the API Key field of your Orderful subscription in iPaaS.com.
Save the subscription.
Optional Configuration: Transaction Tracking Match Method
This feature helps define how tracking details from Orderful’s Ship Notice/Manifest (856) correspond to iPaaS transactions. Choose from the following options:
ShipmentIdentification:
Searches Orderful transactions using the
shipmentIdentificationfield in the ship notice manifest.If a match is found, iPaaS.com will link the transaction.
If no match is found, an error will occur.
PurchaseOrderNumber:
Searches Orderful transactions using the
purchaseOrderNumberfield.This is the default method if no match method is specified.
Fallback:
First searches the
purchaseOrderNumberfield.If not found, searches the
shipmentIdentificationfield.Links the first match found or returns an error if no match exists.
Initialization
Currently, initialization is not supported for Orderful in iPaaS.com. All data synchronization and mappings must be configured manually during the integration process.
Throttling
Throttling ensures that Orderful’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.