Overview

This node interacts with the FreeWebStore API to retrieve multiple customer records. It supports fetching a list of customers with options to limit the number of results, include deleted customers, and sort the results by various fields such as creation date, company name, email, forename, surname, total orders, and total sales. This operation is useful for scenarios where you need to bulk retrieve customer data for analysis, reporting, or integration with other systems.

Use Case Examples

1. Retrieve up to 100 customers sorted by creation date in descending order.
2. Fetch all customers including those marked as deleted.
3. Get a list of customers sorted by total sales in ascending order.

Properties

Output

JSON

• id - Unique identifier of the customer.
• email - Email address of the customer.
• forename - Customer's first name.
• surname - Customer's last name.
• companyname - Name of the company the customer is associated with.
• created - Timestamp when the customer record was created.
• deleted - Boolean indicating if the customer is deleted.
• total_orders - Total number of orders placed by the customer.
• total_sales - Total sales amount associated with the customer.

Dependencies

• FreeWebStore API key credential

Troubleshooting

• Ensure the API key credential is correctly configured and has the necessary permissions to access customer data.
• If the node returns an error, check the network connectivity to the FreeWebStore API endpoint.
• Verify that the 'limit' parameter is within acceptable bounds as per the API documentation to avoid request failures.
• If no customers are returned, confirm that the filters and sort options are correctly set and that there are customers matching the criteria.

Links

• FreeWebStore API Customer Documentation - Official API documentation for customer-related endpoints and parameters.