Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Category Tree → Delete a Category Tree

AI-generated

Overview

This node operation deletes a specific Category Tree in the Fredhopper Product Discovery system. It is useful for managing and maintaining category structures by removing outdated or unnecessary category trees. For example, if a category tree is no longer relevant or needs to be replaced, this operation can be used to delete it by specifying the tenant, environment, category tree name, and version.

Use Case Examples

  1. Deleting a category tree named 'SummerCollection' version '1.0' in a specific tenant and environment to clean up obsolete data.
  2. Removing a category tree that is no longer used in the product catalog to maintain an organized category structure.

Properties

Name Meaning
Tenant The tenant identifier where the category tree exists. Required to specify the scope of the operation.
Environment The environment within the tenant where the category tree exists. Required to specify the scope of the operation.
Category Tree Name The name of the category tree to delete. Required to identify the specific category tree.
Category Tree Version The version of the category tree to delete. Required to specify the exact version of the category tree.

Output

JSON

  • deleted - Indicates whether the category tree 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 expired API credentials. Ensure the API key credential is valid and has the necessary permissions.
  • Errors may occur if the specified category tree name or version does not exist. Verify the category tree name and version are correct before attempting deletion.
  • Network or API endpoint issues can cause request failures. Check network connectivity and API endpoint availability.

Discussion