Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions20

Overview

The node interacts with the Fredhopper Product Discovery API to manage category trees among other resources. Specifically, for the Category Tree resource and the List Category Trees operation, it retrieves a list of category trees from the API.

This operation is useful when you want to fetch all or a subset of category trees configured in your Fredhopper environment, for example, to display them, synchronize with another system, or perform further processing.

Practical examples:

  • Retrieve all category trees for auditing or reporting.
  • Fetch a limited number of category trees for quick previews.
  • Simplify the output to get only essential metadata about each category tree.

Properties

Name Meaning
Return All Boolean flag indicating whether to return all category trees or limit the number of results.
Simplify Output Boolean flag to return either the full/raw response or a simplified summary of each category tree.
Limit Maximum number of category trees to return if "Return All" is false (range 1-1000).
Tenant The tenant identifier for which to list category trees (e.g., "solutions").
Environment The environment identifier within the tenant (e.g., "cidp-test").

Output

The node outputs an array of JSON objects representing category trees.

  • If Simplify Output is disabled, the output contains the full raw response from the API for each category tree.
  • If Simplify Output is enabled, each category tree object includes a simplified summary with these fields:
    • name: The name of the category tree.
    • version: The version identifier of the category tree.
    • created: Timestamp when the category tree was created.
    • updated: Timestamp when the category tree was last updated.
    • description: A textual description of the category tree.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Fredhopper Product Discovery API.
  • The node uses OAuth2 client credentials flow to obtain an access token before making API requests.
  • Requires configuration of tenant and environment parameters to target the correct scope in the API.

Troubleshooting

  • Authentication failed: Failed to obtain access token
    This error indicates that the API credentials are invalid or the authentication endpoint is unreachable. Verify the API key credentials and network connectivity.

  • The operation "listCategoryTrees" is not supported!
    This error occurs if the operation parameter is incorrectly set or unsupported. Ensure the operation is exactly "listCategoryTrees" for this resource.

  • Empty or unexpected response
    Check that the tenant and environment values are correct and that category trees exist in the specified scope.

  • Rate limiting or API errors
    If the API returns errors due to rate limits or server issues, consider adding retry logic or checking API status.

Links and References

Discussion