Square icon

Square

Consume Square API

Catalog → Get Catalog Info

AI-generated

Overview

This node interacts with the Square API to retrieve information about the catalog. Specifically, the 'Get Catalog Info' operation fetches metadata or summary information about the catalog in the Square system. This operation is useful for users who want to obtain an overview of their catalog setup, such as version details or other catalog-wide information, without retrieving individual catalog items.

Use Case Examples

  1. A retail business using Square can use this node to get catalog info to check the current catalog version before performing batch updates.
  2. A developer can integrate this node in an automation workflow to monitor catalog changes or synchronize catalog metadata with another system.

Output

JSON

  • objects - Array of catalog objects returned by the API
  • related_objects - Related objects included in the catalog info response
  • cursor - Cursor for pagination if applicable

Dependencies

  • Square API with an API key credential

Troubleshooting

  • Ensure the Square API credentials are correctly configured and have the necessary permissions to access catalog information.
  • If the node throws a JSON parsing error, verify that any JSON input fields (not applicable for this operation) are correctly formatted.
  • Network or API rate limit errors may occur; check network connectivity and Square API usage limits.

Discussion