Actions21
Overview
This node integrates with the Square API to manage customer data. Specifically, the "Customer" resource with the "Get Many" operation allows users to retrieve multiple customer records from their Square account. It supports fetching either all customers or a limited number of them based on user input.
Common scenarios where this node is beneficial include:
- Synchronizing customer lists from Square into other systems.
- Generating reports or analytics on customer data.
- Automating workflows that require bulk access to customer information.
For example, a business might use this node to pull all customer records daily and update their CRM system automatically.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all customer records or only up to a specified limit. |
| Limit | The maximum number of customer records to return when "Return All" is set to false. |
Output
The node outputs an array of JSON objects representing customer records retrieved from Square. Each object corresponds to a single customer and contains fields as defined by the Square API's customer schema (e.g., name, email, phone number, etc.).
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Square API.
- The node uses the Square API base URL, which switches between sandbox and production environments based on the configured credentials.
- No additional external dependencies are required beyond the Square API access.
Troubleshooting
Common Issues:
- Exceeding API rate limits may cause errors; consider enabling retry logic or reducing request frequency.
- Providing invalid or expired API credentials will result in authentication errors.
- Requesting too many records without setting "Return All" properly may lead to incomplete data retrieval.
Error Messages:
- Errors returned from the Square API are propagated. For example, if the customer ID is invalid or not found, the node throws an error with the message from the API.
- If no customers are found, the output will be an empty array rather than an error.
- If the "Limit" property is set below 1, the node may throw a validation error before making the API call.
To resolve these issues:
- Verify API credentials and permissions.
- Adjust "Return All" and "Limit" settings according to your needs.
- Handle errors gracefully using the node's "Continue On Fail" option if available.