Actions21
Overview
This node integrates with the Square API to perform operations related to customers, bookings, and invoices. Specifically, for the Customer - Search operation, it allows users to search for customers in their Square account based on various criteria such as email address, phone number, or reference ID. This is useful for workflows that need to retrieve customer information dynamically, for example:
- Finding a customer record before creating an order or booking.
- Filtering customers based on contact details for targeted marketing.
- Synchronizing customer data between Square and other systems.
The node supports returning all matching results or limiting the number of results returned.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching customer records or only up to a specified limit. |
| Limit | Maximum number of customer records to return if "Return All" is false. |
| Search Fields | Fields to filter the customer search by. Options include: |
| - Email Address: Search by customer's email address. | |
| - Phone Number: Search by customer's phone number. | |
| - Reference ID: Search by a custom reference ID associated with the customer. |
Output
The output is a JSON array where each item represents a customer object retrieved from the Square API. Each customer object contains detailed customer information as provided by Square, such as name, contact details, and metadata.
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 endpoints, switching between sandbox and production environments based on the configured credentials.
- No additional external dependencies are required beyond the Square API access.
Troubleshooting
- Empty Results: If no customers are returned, verify that the search fields are correctly set and match existing customer data in Square.
- API Errors: Errors from the Square API (e.g., invalid authentication, rate limits) will be surfaced. Ensure the API key is valid and has appropriate permissions.
- Limit Exceeded: When not returning all results, ensure the "Limit" property is set to a reasonable number to avoid truncation.
- Invalid Search Fields: Providing unsupported or empty search fields may result in no matches or errors. Use only the supported fields: email address, phone number, and reference ID.
If the node is set to continue on failure, errors will be returned as part of the output JSON with an error field describing the issue.