Square icon

Square

Consume Square API

Actions37

Catalog → List

AI-generated

Overview

This node operation lists catalog objects from the Square API. It allows users to retrieve catalog items, categories, discounts, and other object types from their Square catalog. Users can choose to return all results or limit the number of results returned. Filters such as object types and catalog version can be applied to refine the results. This operation is useful for scenarios where users need to fetch and process catalog data for inventory management, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve all catalog items and categories to sync with an external inventory system.
  2. Fetch a limited number of catalog objects of specific types for display in a custom application.
  3. Get catalog data for a specific catalog version to audit changes or updates.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of catalog objects to return when 'Return All' is false.
Filters Filters to apply when listing catalog objects, including types of objects and catalog version.

Output

JSON

  • objects - Array of catalog objects retrieved from the Square API.

Dependencies

  • Square API with an API key credential for authentication.

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access catalog data.
  • If the 'Return All' option is selected, be aware that large catalogs may result in longer execution times or timeouts.
  • Invalid filter values, such as incorrect object types or catalog version numbers, may result in empty or error responses.

Links

Discussion