Erply API
AI-generatedOverview
This node integrates with the Erply API, allowing users to perform various API requests against their Erply account by specifying a client code and request type. It is useful for automating interactions with Erply's services such as retrieving service endpoints, managing inventory, sales, or other business data managed within Erply.
Typical use cases include:
- Fetching data from Erply (e.g., product lists, customer records).
- Sending commands or updates to Erply via its API.
- Automating workflows that require dynamic querying of Erply data based on parameters.
For example, a user might configure this node to call the "getServiceEndpoints" request to retrieve available API endpoints or specify other requests to interact with different parts of the Erply system.
Properties
| Name | Meaning |
|---|---|
| Client code | The unique client code identifying the Erply account to connect to. |
| Request | The specific API request to send to Erply. Default is "getServiceEndpoints". |
| Include Headers | Boolean flag indicating whether to include HTTP response headers in the output. |
| JMES Path | A JMESPath expression used to extract and transform data from the API response JSON. Default is "records". |
| Parameters | A collection of key-value pairs representing additional query string parameters to include in the API request. |
Output
The node outputs JSON data derived from the Erply API response. By default, it extracts the part of the response specified by the JMESPath expression (default: records), which typically contains the main data payload relevant to the request.
If "Include Headers" is enabled, the output will also contain the full HTTP response including headers.
No binary data output is produced by this node.
Dependencies
- Requires an active Erply API credential (an API key or token) configured in n8n to authenticate requests.
- Network access to the Erply API endpoint constructed dynamically using the provided client code.
- Uses POST method by default for API requests.
Troubleshooting
- Invalid Client Code: If the client code is incorrect or missing, the API will fail to authenticate or route the request properly. Verify the client code matches your Erply account.
- Incorrect Request Name: Using an unsupported or misspelled request name will result in API errors. Check Erply API documentation for valid request names.
- Parameter Formatting: Ensure additional parameters are correctly formatted as key-value pairs; malformed parameters may cause request failures.
- Include Headers Option: Enabling this option changes the output format; downstream nodes expecting only JSON data may need adjustment.
- Network Issues: Connectivity problems or firewall restrictions can prevent successful API calls.
Common error messages usually relate to authentication failure, invalid parameters, or network timeouts. Resolving these involves checking credentials, parameter correctness, and network configuration.
Links and References
- Erply API Documentation – Official API reference for available requests and parameters.
- JMESPath Tutorial – Guide to writing expressions for extracting data from JSON responses.