Square

Overview

The node integrates with the Square API to manage bookings, specifically allowing users to cancel an existing booking. This operation is useful in scenarios where a scheduled appointment or reservation needs to be terminated before its scheduled time. For example, a business might use this node to automate cancellation of customer appointments due to unforeseen circumstances or upon customer request.

Practical examples include:

• Automatically cancelling a booking when a customer requests it via a chatbot.
• Cancelling bookings that are no-shows or requested by the seller.
• Integrating booking cancellations into broader workflows such as refunds or notifications.

Properties

Output

The node outputs JSON data representing the response from the Square API after attempting to cancel the booking. This typically includes details about the cancelled booking, confirmation status, and any relevant metadata returned by the API.

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 endpoint for bookings, switching between sandbox and production environments based on the configured credentials.
• Network connectivity to Square's API endpoints is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing Booking ID will cause the cancellation request to fail.
  • Using an incorrect cancellation reason value not among the allowed options may result in an error.
  • API authentication failures if the API key credential is invalid or expired.
  • Network errors or rate limiting by Square API.

• Error messages:

  • Errors returned from the Square API will be propagated, often indicating issues like "Booking not found" or "Invalid cancellation reason".
  • If the node is set to continue on failure, errors will be included in the output JSON with an error field.

• Resolutions:

  • Verify the Booking ID exists and is correct.
  • Use one of the predefined cancellation reasons.
  • Ensure the API key credential is valid and has appropriate permissions.
  • Check network connectivity and retry if rate limited.

Links and References

• Square Bookings API Documentation
• Square API Authentication Guide