Square icon

Square

Consume the Square API

Overview

This node integrates with the Square API to manage customer data. Specifically, the Customer Update operation allows users to modify existing customer records by specifying the customer ID and the fields to update. This is useful in scenarios where customer information changes over time, such as updating contact details, addresses, or other personal information.

Practical examples include:

  • Updating a customer's email address after they provide a new one.
  • Changing the postal address when a customer moves.
  • Adding notes or reference IDs for internal tracking purposes.

Properties

Name Meaning
Customer ID The unique identifier of the customer to update.
Update Fields A collection of fields that can be updated for the customer. Options include:
- Address Customer's address details including: Address Line 1, Address Line 2, City (Locality), State, Postal Code, and Country (ISO 3166-1 alpha-2 code).
- Birthday Customer's birthday in YYYY-MM-DD or MM-DD format.
- Company Name The company name associated with the customer.
- Email Address Customer's email address.
- Family Name Customer's family (last) name.
- Given Name Customer's given (first) name.
- Nickname Customer's nickname.
- Note Additional notes about the customer.
- Phone Number Customer's phone number.
- Reference ID An external reference ID for the customer.

Output

The node outputs JSON data representing the updated customer object returned from the Square API. This typically includes all customer details after the update has been applied.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Square API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL switches between sandbox and production environments based on credential settings.

Troubleshooting

  • Error: "Please enter at least one field to update for the customer"
    This error occurs if no update fields are provided. Ensure you specify at least one field to update.

  • API errors related to invalid Customer ID
    If the provided Customer ID does not exist or is malformed, the API will return an error. Verify the correctness of the Customer ID.

  • Authentication errors
    If the API key or token is missing or invalid, requests will fail. Confirm that the API credentials are correctly set up in n8n.

  • Rate limiting or network issues
    Temporary failures may occur due to rate limits or connectivity problems. Retrying the operation later or checking network status can help.

Links and References

Discussion