Square icon

Square

Consume Square API

Overview

The node integrates with the Square API to search for booking availability based on specified criteria. It allows users to query available booking slots within a given time range, location, and service variation filters. This is useful for businesses that want to automate checking available appointment times or resources before creating bookings.

Practical examples:

  • A salon uses this node to find open appointment slots for specific services and team members.
  • A fitness center checks availability of trainers and rooms before scheduling sessions.
  • An event organizer queries available time ranges at different locations to plan events.

Properties

Name Meaning
Query Collection of parameters defining the search criteria for availability. Includes:
- Filter: Contains detailed filters such as:
  • Start At Range: Time range with start and end datetime to limit availability search.
  • Location ID: The identifier of the location where availability is checked.
  • Segment Filters: Multiple filters for segments including:
    - Service Variation ID: Filter by specific service variation.
    - Team Member ID Filter: Filter by one or more team member IDs.

Output

The output JSON contains the response from the Square API's booking availability search endpoint. It typically includes available time slots and related metadata matching the query filters.

If binary data were returned (not indicated here), it would represent downloadable content related to the availability search, but this node focuses on JSON data.

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 credential configuration.
  • No additional external dependencies are required beyond the Square API access.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication errors.
    • Incorrect date/time formats in the "Start At Range" may lead to request failures.
    • Providing invalid or non-existent Location ID, Service Variation ID, or Team Member IDs will result in empty or error responses.
  • Error messages:
    • Authentication errors: Ensure the API key credential is correctly configured and has necessary permissions.
    • Validation errors: Check that all required fields in the query are properly formatted and valid.
    • Rate limiting or API downtime: Retry after some time or check Square API status.

Links and References

Discussion