Actions31
- Authentication Actions
- Catalog Actions
- Category Tree Actions
- Item Actions
- Locale Actions
Category Tree → Get a Category Tree
AI-generatedOverview
This node operation retrieves a specific category tree from the Fredhopper Product Discovery API. It is useful for scenarios where you need to fetch detailed hierarchical category data for a tenant and environment, such as for product categorization or navigation structures in e-commerce platforms.
Use Case Examples
- Fetch a category tree named 'SpringCollection' version '1.0' for tenant 'TenantA' in the 'Production' environment to display product categories on a website.
- Retrieve a specific version of a category tree to analyze or update category structures programmatically.
Properties
| Name | Meaning |
|---|---|
| Tenant | The tenant identifier for which the category tree is associated. |
| Environment | The environment (e.g., production, staging) where the category tree exists. |
| Category Tree Name | The name of the category tree to retrieve. |
| Category Tree Version | The version of the category tree to retrieve. |
Output
JSON
name- Name of the category tree.version- Version of the category tree.created- Timestamp when the category tree was created.updated- Timestamp when the category tree was last updated.description- Description of the category tree.categories- The hierarchical category data contained in the tree.
Dependencies
- Fredhopper Product Discovery API
- An API key credential for authentication
Troubleshooting
- Ensure the tenant, environment, category tree name, and version are correctly specified; incorrect values will result in errors or empty responses.
- Authentication failures may occur if the API credentials are invalid or expired; verify the API key and tenant authentication URL.
- Network issues or API endpoint changes can cause request failures; check connectivity and API documentation for updates.
Links
- Fredhopper Product Discovery API Documentation - Official API documentation for understanding endpoints and parameters related to category trees.