Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Catalog → Create Catalog With Default Batch

AI-generated

Overview

This node operation creates a new catalog with a default batch in the Fredhopper Product Discovery system. It is useful for users who want to quickly set up a catalog along with an associated default batch for product data ingestion and management. For example, an e-commerce platform can use this operation to initialize a new product catalog and prepare it for batch updates automatically.

Use Case Examples

  1. Create a new product catalog with default batch for tenant 'TenantA' in environment 'Production' using provided catalog data JSON.
  2. Automate catalog creation and batch setup as part of a product data pipeline.

Properties

Name Meaning
Tenant The tenant identifier for the catalog to be created.
Environment The environment (e.g., production, staging) where the catalog will be created.
Catalog Data The JSON string representing the catalog data to be created.

Output

JSON

  • success - Indicates if the catalog creation was successful.
  • message - A message describing the result of the catalog creation.
  • catalogVersion - The version identifier of the newly created catalog.
  • tenant - The tenant under which the catalog was created.
  • environment - The environment where the catalog was created.
  • status - The status of the catalog, typically 'inactive' upon creation.
  • note - Additional notes about the catalog creation, e.g., activation instructions.
  • defaultBatchId - The batch ID associated with the default batch, usually the same as the catalog version.
  • response - The full response object returned from the API call.

Dependencies

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

Troubleshooting

  • Ensure the 'Catalog Data' input is valid JSON; invalid JSON will cause an error.
  • Authentication failures may occur if API credentials are incorrect or missing.
  • The catalog will be created in an inactive state; remember to activate it using the appropriate operation.

Discussion