Actions16
Overview
This node interacts with a cloud commerce platform to manage various resources, including customers. Specifically, the Customer - Get Many operation retrieves multiple customer records based on optional filtering criteria. It is useful when you want to fetch a list of customers for reporting, synchronization, or bulk processing tasks.
Typical use cases include:
- Retrieving all customers or a limited subset for display or export.
- Filtering customers by attributes such as name, email, external ID, or reseller ID.
- Integrating customer data into other systems or workflows.
For example, you might use this node to get all customers whose names contain "Smith" or to retrieve up to 50 customers associated with a particular reseller.
Properties
Name | Meaning |
---|---|
Return All | Whether to return all matching customer records or limit the number of results returned. |
Limit | Maximum number of customer records to return (used only if "Return All" is false). |
Filters | Collection of filters to narrow down the customers retrieved: |
Name | Filter customers by partial match on their name. |
Filter customers by contact email address. | |
External ID | Filter customers by an external identifier. |
Reseller ID | Filter customers by reseller identifier. |
Output
The output is an array of JSON objects, each representing a customer record that matches the query parameters. Each item in the output contains a json
field with the customer's data properties as returned from the API.
If the operation is set to return many customers, the output will be a concatenated list of these customer JSON objects.
No binary data output is indicated for this operation.
Dependencies
- Requires an initialized API service connection to the cloud commerce platform. This typically involves configuring an API key or authentication token within n8n credentials.
- The node depends on a resource registry system internally to resolve and execute resource-specific operations.
- No additional external dependencies are explicitly required beyond the configured API access.
Troubleshooting
- Resource Not Found Error: If the specified resource (e.g., "customer") is not recognized, ensure the node's configuration includes support for that resource and that the integration is properly installed.
- API Authentication Errors: Failures related to authentication usually indicate missing or invalid API credentials. Verify that the API key or token is correctly set up in n8n.
- Limit and Return All Conflicts: Setting both "Return All" to false and a very high "Limit" may cause unexpected truncation of results. Adjust these settings according to your needs.
- Filter Misconfiguration: Providing invalid filter values or unsupported filter fields may result in empty results or errors. Double-check filter inputs for correctness.
- Error Handling: If an error occurs during execution, the node can either stop or continue depending on the "Continue On Fail" setting. When continuing, errors are included in the output JSON under an
error
property.
Links and References
- n8n Documentation
- Relevant API documentation for the cloud commerce platform (not provided here)
- General best practices for API pagination and filtering in n8n nodes