Omniwallet - Get Customers Tool icon

Omniwallet - Get Customers Tool

Retrieve customers from Omniwallet API Tool

Overview

This node, named "Omniwallet - Get Customers Tool," is designed to retrieve customer data from the Omniwallet API. It allows users to fetch paginated lists of customers with optional filtering by creation date and sorting by various fields. This node is useful in scenarios where you need to integrate customer data from Omniwallet into workflows for analysis, reporting, or further processing.

Practical examples include:

  • Fetching a specific page of customers to display in a dashboard.
  • Filtering customers created after a certain date for targeted marketing campaigns.
  • Sorting customers by points or last name to prioritize engagement.

Properties

Name Meaning
Page Size Number of items per page (minimum 1, maximum 100).
Page Number Page number to retrieve (minimum 1).
Filter by Created At Filter customers by their creation date. Accepts date strings in YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss format.
Sort By Field to sort customers by. Options: Created At, Email, Last Name, Name, None, Points, Updated At.
Sort Order Sort order direction when sorting is applied. Options: Ascending, Descending. Only shown if a valid sort field is selected.

Output

The node outputs an array of JSON objects representing customers retrieved from the Omniwallet API. Each item corresponds to one input item processed and contains the customer data under the json property. The structure of each customer object matches the API response's data field.

No binary data output is produced by this node.

Example output snippet:

{
  "json": {
    "id": "customer_123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "createdAt": "2023-01-15T12:34:56Z",
    "points": 150,
    ...
  },
  "pairedItem": {
    "item": 0
  }
}

Dependencies

  • Requires an API key credential for authenticating requests to the Omniwallet API.
  • The node uses an internal helper function (omniwalletApiRequest) to perform HTTP GET requests.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing invalid date formats in the "Filter by Created At" property may result in no data returned or API errors.
    • Requesting page sizes above 100 or page numbers below 1 will be rejected due to validation constraints.

  • Error messages:

    • If the API request fails, the node returns an error message including the failure reason and the parameters used for that request.
    • When "Continue On Fail" is enabled, errors for individual items do not stop execution but are included in the output as error objects.

  • Resolution tips:

    • Ensure the API key credential is correctly set up and has necessary permissions.
    • Use valid ISO date formats for filtering.
    • Respect the allowed ranges for pagination properties.

Links and References

  • Omniwallet API Documentation (refer to your Omniwallet API provider's official docs for detailed endpoints and parameters)
  • n8n Documentation on creating custom nodes and using credentials

Discussion