Omniwallet - Get Customers icon

Omniwallet - Get Customers

Retrieve customers from Omniwallet API
Join our community

Overview

This node retrieves customer data from the Omniwallet API. It is designed to fetch a paginated list of customers with optional filtering by creation date and sorting by various fields. This node is useful for workflows that need to integrate customer information from Omniwallet, such as syncing customer lists, generating reports, or triggering actions based on customer attributes.

Practical examples:

  • Fetching the first 50 customers created after a specific date.
  • Retrieving customers sorted by their points in descending order.
  • Paginating through customer records to process them in batches.

Properties

Name Meaning
Page Size Number of items per page (1 to 100).
Page Number Page number to retrieve (starting from 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 by a field. Options: Ascending, Descending. Only applicable if "Sort By" is set to a field other than None.

Output

The node outputs a JSON array containing a single object with the following structure:

  • debug: Contains diagnostic information including:
    • credentials: Masked API key presence indicator, subdomain, and version used.
    • endpoint: The API endpoint path with query parameters used.
    • queryParams: The actual query parameters sent to the API.
  • response: The raw response data returned from the Omniwallet API containing the customers' data.

If an error occurs during the request, the output will contain:

  • debug: Same credential and endpoint info.
  • error: An object with message and stack describing the error encountered.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Omniwallet API.
  • Uses the internal helper function omniwalletApiRequest to perform HTTP requests.
  • No additional environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date format in the "Filter by Created At" property may result in no data or errors.
    • Requesting a page number or size outside allowed ranges may lead to empty results or API errors.

  • Error messages:

    • Errors thrown by the API or network issues will be captured and returned in the output under the error field.
    • The node masks sensitive API key information but includes error messages and stack traces for debugging.

  • Resolution tips:

    • Verify API credentials are correctly configured.
    • Ensure date filters follow the expected format.
    • Adjust pagination parameters within allowed limits.

Links and References

Discussion