Square icon

Square

Consume Square API

Overview

This node interacts with the Square API to retrieve booking-related information. Specifically, the "Get Location Profile" operation fetches the booking profile details for a specified location. This is useful for businesses that manage appointments or services across multiple locations and want to programmatically access configuration or profile data related to bookings at a particular site.

Practical examples include:

  • Retrieving booking settings or availability rules for a specific store location.
  • Integrating location-specific booking profiles into a custom dashboard or CRM.
  • Automating workflows that depend on location-based booking configurations.

Properties

Name Meaning
Location ID The unique identifier of the location for which to retrieve the booking profile details.

Output

The output is a JSON object representing the booking profile of the specified location as returned by the Square API endpoint /bookings/location-booking-profiles/{locationId}.

The structure typically includes details such as:

  • Booking policies and settings for the location.
  • Available services or resources linked to the location.
  • Scheduling rules or constraints.

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Square API via an API key credential configured in n8n.
  • The node uses the Square API base URL, switching between sandbox and production environments based on credential settings.
  • No additional external dependencies are required beyond the Square API access.

Troubleshooting

  • Common issues:

    • Invalid or missing Location ID will cause the API request to fail.
    • Network connectivity problems or incorrect API credentials can result in authentication errors.
    • If the location does not have a booking profile set up, the response may be empty or contain error messages.
  • Error messages:

    • Errors from the Square API (e.g., 404 Not Found if the location ID is invalid) will be surfaced by the node.
    • To handle errors gracefully, enable "Continue On Fail" in the node settings to prevent workflow interruption.
    • Ensure the Location ID is correct and corresponds to an existing location in your Square account.

Links and References

Discussion