Square icon

Square

Consume Square API

Overview

This node interacts with the Square API to manage bookings. Specifically, the Booking - Get operation retrieves detailed information about a single booking by its unique Booking ID. This is useful when you want to fetch the current status, details, or metadata of a specific booking made through Square.

Common scenarios include:

  • Retrieving booking details for display in dashboards or reports.
  • Verifying booking information before performing updates or cancellations.
  • Integrating booking data into other workflows or systems for further processing.

Example: You have a booking system integrated with Square and want to pull the details of a particular booking to confirm the appointment time and customer information before sending a reminder email.

Properties

Name Meaning
Booking ID The unique identifier of the booking to retrieve. This is required to specify which booking's details to fetch.

Output

The output is a JSON object representing the booking details as returned by the Square API. It typically includes fields such as booking ID, location, customer info, start and end times, service details, status, and any custom attributes associated with the booking.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Square API.
  • The node uses the Square API base URL, switching between sandbox and production environments based on the configured credentials.
  • No additional external dependencies are needed beyond the Square API access.

Troubleshooting

  • Error: Invalid or missing Booking ID
    Ensure that the Booking ID property is provided and correctly formatted. Without a valid Booking ID, the API call will fail.

  • Error: Authentication failed
    Verify that the API key credential is correctly set up and has permissions to access booking data.

  • Error: Booking not found
    The specified Booking ID may not exist or may belong to a different account/environment. Double-check the ID and environment settings.

  • Continue On Fail behavior
    If enabled, errors for individual items will be captured in the output as error messages instead of stopping execution.

Links and References

Discussion