Square icon

Square

Consume Square API

Actions37

Catalog → Search Objects

AI-generated

Overview

This node operation allows searching for catalog objects in the Square API based on a query filter. It supports returning all results or limiting the number of results, and can include additional options such as filtering by object types, including deleted objects, and including related objects. This is useful for scenarios where you need to find specific catalog items, categories, or other object types within a Square catalog, for example, searching for all coffee-related items or categories.

Use Case Examples

  1. Search catalog objects with a keyword filter for 'coffee'.
  2. Return all catalog objects of types ITEM and CATEGORY.
  3. Include deleted and related objects in the search results.

Properties

Name Meaning
Search Query The JSON query filter used to search catalog objects. If left empty, all objects are returned.
Return All Whether to return all matching results or limit the number of results.
Limit The maximum number of results to return when 'Return All' is false.
Additional Fields Additional optional parameters to refine the search, including object types to search, whether to include deleted objects, and whether to include related objects.

Output

JSON

  • objects - Array of catalog objects matching the search criteria.

Dependencies

  • Square API with an API key credential for authentication.

Troubleshooting

  • Ensure the 'Search Query' field contains valid JSON; otherwise, a parsing error will occur.
  • If the API returns an error, check the API key credentials and permissions.
  • When 'Return All' is true, large result sets may take longer to fetch and could hit API rate limits.

Links

Discussion