Overview

This node operation performs a batch retrieval of catalog objects from the Square API. It allows users to specify multiple catalog object IDs in a comma-separated string to fetch their details in a single request. Additional options include whether to include related objects referenced by these catalog objects and specifying a particular catalog version to retrieve. This operation is useful for efficiently obtaining detailed information about multiple catalog items at once, such as product details, categories, or modifiers, which can be used in inventory management, e-commerce platforms, or integration workflows.

Use Case Examples

1. Retrieve details of multiple catalog items by providing their IDs in a comma-separated list.
2. Include related objects to get comprehensive data about catalog items and their references.
3. Specify a catalog version to retrieve historical or specific versions of catalog objects.

Properties

Output

JSON

• object_ids - Array of catalog object IDs requested for retrieval.
• include_related_objects - Flag indicating if related objects were included in the response.
• catalog_version - The version of the catalog objects retrieved.
• objects - Array of catalog objects retrieved from the batch request, containing detailed information about each object.

Dependencies

• Square API with an API key credential for authentication

Troubleshooting

• Ensure the object IDs are correctly formatted as a comma-separated string without extra spaces or invalid characters.
• If the API returns an error, verify that the provided object IDs exist and the API credentials have the necessary permissions.
• Check that the catalog version number is valid and corresponds to an existing version in the Square catalog.