Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Catalog → Activate a Catalog Version

AI-generated

Overview

This node operation activates a specific version of a catalog in the Fredhopper Product Discovery system. It is useful when you want to make a particular catalog version live and available for use, such as after creating or updating a catalog version. For example, after uploading a new catalog version, you can use this operation to activate it so that it becomes the active catalog version in your environment.

Use Case Examples

  1. Activate catalog version '11' for tenant 'tenantA' in environment 'production'.
  2. Activate a newly created catalog version to make it live.

Properties

Name Meaning
Tenant The tenant identifier for the catalog environment where the catalog version exists.
Environment The environment (e.g., production, staging) where the catalog version is to be activated.
Catalog Version The specific version of the catalog to activate.

Output

JSON

  • success - Indicates if the catalog activation was successful.
  • message - A message confirming the catalog version activation.
  • catalogVersion - The catalog version that was activated.
  • tenant - The tenant for which the catalog version was activated.
  • environment - The environment where the catalog version was activated.
  • status - The status of the catalog after activation, typically 'active'.
  • response - The raw or simplified response from the API confirming activation.

Dependencies

  • Requires an API key credential for authentication to the Fredhopper Product Discovery API.

Troubleshooting

  • Ensure the catalog version specified exists and is valid; otherwise, the activation will fail.
  • Verify that the tenant and environment parameters are correct and correspond to the catalog version.
  • Authentication errors may occur if the API credentials are invalid or expired; re-authenticate if needed.
  • If the API returns an error, check the response message for details and ensure the catalog version is not already active or locked.

Discussion