Actions31
- Authentication Actions
- Catalog Actions
- Category Tree Actions
- Item Actions
- Locale Actions
Catalog → List Catalogs
AI-generatedOverview
This node interacts with the Fredhopper Product Discovery API to list catalogs for a specified tenant and environment. It supports fetching all catalogs or limiting the number of results, and optionally simplifying the output to a summary format. This is useful for users who need to retrieve catalog information programmatically, such as for inventory management, catalog synchronization, or reporting.
Use Case Examples
- Retrieve all catalogs for a tenant and environment to display in a dashboard.
- Fetch a limited number of catalogs with simplified details for quick overview or monitoring.
Properties
| Name | Meaning |
|---|---|
| Return All | Determines if all catalog results should be returned or only up to a specified limit. |
| Simplify Output | If enabled, returns a simplified summary of each catalog instead of the full raw output. |
| Limit | Maximum number of catalog results to return when 'Return All' is false. |
| Tenant | The tenant identifier for which catalogs are to be listed. |
| Environment | The environment identifier for which catalogs are to be listed. |
Output
JSON
version- Catalog version identifier.status- Current status of the catalog (e.g., active, inactive).created- Timestamp when the catalog was created.updated- Timestamp when the catalog was last updated.description- Description of the catalog.
Dependencies
- Fredhopper Product Discovery API with authentication via an API key credential
Troubleshooting
- Authentication failures due to invalid or missing credentials. Ensure the API key credential is correctly configured.
- Invalid tenant or environment parameters may result in no data or errors. Verify these inputs are correct.
- If 'Return All' is false and 'Limit' is set too low, not all catalogs will be retrieved.
- Malformed JSON or unexpected API responses may cause errors; check API status and response format.
Links
- Fredhopper Product Discovery API Documentation - Official API documentation for understanding endpoints and parameters.