Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions31

Catalog → Delete Catalog

AI-generated

Overview

This node operation deletes a specific catalog version within the Fredhopper Product Discovery system. It requires the user to specify the tenant, environment, and catalog version to identify the catalog to be deleted. This operation is useful for managing and cleaning up catalogs that are no longer needed or relevant, ensuring that only active and necessary catalogs remain in the system.

Use Case Examples

  1. Deleting an outdated catalog version to free up resources and maintain an organized catalog system.
  2. Removing a catalog version that was created by mistake or is no longer valid.

Properties

Name Meaning
Tenant The tenant identifier under which the catalog exists. This is required to specify the scope of the catalog deletion.
Environment The environment (e.g., production, staging) where the catalog resides. This helps target the correct catalog instance for deletion.
Catalog Version The specific version of the catalog to delete. This is required to identify the exact catalog version to be removed.

Output

JSON

  • deleted - Indicates whether the catalog was successfully deleted (true if deleted).

Dependencies

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

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • If the specified catalog version does not exist, the node may throw an error indicating the catalog could not be found. Verify the catalog version, tenant, and environment values are correct.
  • Network or permission issues may cause the deletion request to fail. Check network connectivity and API permissions.

Discussion