Overview
This node interacts with the Orderful platform to manage EDI (Electronic Data Interchange) transactions. It supports operations such as retrieving a specific transaction, listing multiple transactions, creating new transactions or acknowledgments, confirming delivery of transactions, and fetching transaction messages.
A common use case is automating the retrieval and processing of EDI transactions between trading partners, such as purchase orders, invoices, or shipment notices. For example, a user can fetch details of a particular transaction by its ID or list all pending transactions within a date range. Another practical scenario is creating a new transaction by sending structured JSON data representing an EDI document.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform on Orderful transactions. Options: Confirm Delivery, Create, Create Acknowledgment, Get, Get Message, List. |
| Transaction ID | The unique identifier of the transaction. Required for "Get" and "Get Message" operations. |
| Transaction Type | The type of transaction to create. Options include Purchase Order (850), Purchase Order Acknowledgment (855), Ship Notice/Manifest (856), Invoice (810), Motor Carrier Load Tender (204), Response to Load Tender (990), Transportation Carrier Shipment Status (214). Used in "Create" operation. |
| Transaction Data | The transaction content in JSON format. Required for "Create" operation. |
| Partner ID | The ID of the trading partner involved in the transaction. Required for "Create" operation. |
| Additional Fields | Filters and options for listing transactions, including End Date, Limit (max results), Start Date, Status (Pending, Processed, Failed, Delivered), and Transaction Type filter. Used in "List" operation. |
| Transaction IDs | Comma-separated list of transaction IDs to confirm delivery. Required for "Confirm Delivery" operation. |
Output
The node outputs JSON data representing the response from the Orderful API for the selected operation. This typically includes transaction details such as IDs, types, statuses, timestamps, and any relevant metadata returned by the API.
If the operation involves multiple items (e.g., listing transactions), the output is an array of transaction objects.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Orderful API.
- Needs configuration of the base URL for the Orderful API endpoint.
- Uses HTTP requests with JSON payloads and expects JSON responses.
- Requires n8n's HTTP request helper with authentication support configured for the Orderful API.
Troubleshooting
- Invalid JSON in transaction data: When creating a transaction, the node expects valid JSON in the "Transaction Data" property. If invalid JSON is provided, the node will throw an error. To fix, ensure the JSON syntax is correct.
- Missing required fields: Operations like "Get" and "Get Message" require a valid Transaction ID; "Create" requires Transaction Type, Transaction Data, and Partner ID. Omitting these will cause errors.
- API authentication errors: Ensure the API key credential and base URL are correctly set up in n8n credentials. Authentication failures will prevent successful API calls.
- Rate limits or network issues: If the API returns errors related to rate limiting or connectivity, consider adding retry logic or checking network access.
- Continue On Fail behavior: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.
Links and References
- Orderful API Documentation (for detailed API endpoints and data formats)
- EDI Transaction Types Reference (explains common EDI transaction codes like 850, 810, etc.)