Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions20

Overview

The node integrates with the Fredhopper Product Discovery API to manage catalogs and related resources. Specifically, the List Catalogs operation under the Catalog resource retrieves a list of catalogs from the service.

This operation is useful when you want to:

  • Fetch all available catalogs for a given tenant and environment.
  • Retrieve a limited number of catalogs for display or processing.
  • Obtain either detailed raw catalog data or simplified summaries for easier consumption.

Practical examples include:

  • Displaying available product catalogs in an admin dashboard.
  • Synchronizing catalog metadata with other systems.
  • Automating catalog version management workflows.

Properties

Name Meaning
Return All Boolean flag indicating whether to return all catalogs or limit the number of results returned.
Simplify Output Boolean flag to return a simplified summary instead of full/raw catalog data.
Limit Maximum number of catalog results to return (applicable only if Return All is false).
Tenant The tenant identifier for which catalogs are listed (e.g., "solutions").
Environment The environment context for the catalogs (e.g., "cidp-test").

Output

The output is a JSON array containing catalog objects. Each catalog object includes details such as:

  • version or catalogVersion: The version identifier of the catalog.
  • status: The current status of the catalog (e.g., active, inactive).
  • created: Timestamp when the catalog was created.
  • updated: Timestamp of the last update.
  • description: A textual description of the catalog.

If Simplify Output is enabled, each catalog object is reduced to a summary containing only these key fields: version, status, created, updated, and description.

No binary data is produced by this operation.

Dependencies

  • Requires an API authentication token obtained via client credentials (username, password, and auth URL) configured in the node's credentials.
  • The node makes HTTP requests to the Fredhopper Product Discovery API endpoints.
  • Proper tenant and environment values must be provided to scope the catalog listing correctly.

Troubleshooting

  • Authentication failures: If the node cannot obtain an access token, verify that the API credentials (username, password, auth URL) are correct and have sufficient permissions.
  • Empty or unexpected responses: Ensure the tenant and environment parameters are valid and that catalogs exist for those contexts.
  • Limit and Return All conflicts: When Return All is false but Limit is set too high or low, results may not match expectations; adjust accordingly.
  • API errors: Network issues or API downtime can cause request failures; check connectivity and API status.
  • Simplify Output misuse: Enabling simplify will omit many catalog details; disable it if full data is needed.

Links and References

Discussion