Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Overview

This node interacts with the Fredhopper Product Discovery API to manage catalogs and other related resources. Specifically, for the Catalog resource and the Activate a Catalog Version operation, it activates a specified version of a catalog in a given tenant and environment.

This operation is useful when you have multiple versions of a product catalog and want to switch the active version that your system or storefront uses. For example, after uploading and verifying a new catalog version, you can activate it to make it live.

Practical scenarios include:

  • Deploying updated product data to a live e-commerce site.
  • Switching between different catalog versions for testing or rollout purposes.
  • Automating catalog version management as part of a CI/CD pipeline.

Properties

Name Meaning
Tenant The identifier of the tenant (e.g., "solutions") under which the catalog exists.
Environment The environment name (e.g., "cidp-test") where the catalog is managed or activated.
Catalog Version The specific version of the catalog to activate.

Output

The output JSON object includes:

  • success: Boolean indicating if the activation was successful.
  • message: A human-readable message confirming the activation.
  • catalogVersion: The version string of the catalog that was activated.
  • tenant: The tenant identifier used.
  • environment: The environment name used.
  • status: The status of the catalog after activation, typically "active".
  • response: The raw response from the API or a success message string.

Example output JSON:

{
  "success": true,
  "message": "Catalog version 1.2.3 activated successfully",
  "catalogVersion": "1.2.3",
  "tenant": "solutions",
  "environment": "cidp-test",
  "status": "active",
  "response": "Catalog activated successfully"
}

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Fredhopper Product Discovery API.
  • The node performs OAuth2 client credentials flow internally using provided username, password, and auth URL credentials.
  • Network access to the Fredhopper API endpoints (https://items.attraqt.io/catalogs/activate/...) is required.
  • No additional environment variables are needed beyond the configured credentials.

Troubleshooting

  • Authentication failed: Failed to obtain access token
    This error indicates invalid or missing API credentials. Verify that the username, password, and authentication URL are correct and that the API key has sufficient permissions.

  • The operation "activateCatalog" is not supported!
    This suggests a misconfiguration or typo in the operation parameter. Ensure the operation is set exactly to "Activate a Catalog Version".

  • Network errors or timeouts
    Check network connectivity to the Fredhopper API endpoint and ensure no firewall or proxy is blocking requests.

  • Invalid catalog version
    If the specified catalog version does not exist or is malformed, the API may return an error. Confirm the catalog version string is correct.

  • Continue on Fail behavior
    If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.

Links and References

Discussion