Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions31

Item → Submit Batch Ingestion

AI-generated

Overview

This node operation submits a batch ingestion request to the Fredhopper Product Discovery API for a specified catalog version within a tenant and environment. It allows users to ingest a batch of items into a catalog, optionally promoting the catalog upon completion, and setting validation thresholds for the ingestion process. This operation is useful for automating the ingestion of product data batches into a catalog system, ensuring data quality through validation, and managing catalog versions efficiently.

Use Case Examples

  1. Submitting a batch ingestion for catalog version '11' in a specific tenant and environment, with options to promote the catalog after ingestion and enforce minimum item count and success rate thresholds.
  2. Automating the ingestion process in an e-commerce platform where product data batches are regularly updated and validated before being made live.

Properties

Name Meaning
Tenant The tenant identifier for the batch ingestion request.
Environment The environment identifier for the batch ingestion request.
Batch Import ID Optional batch ID returned by the batch creation call; leave empty to ingest the default catalog batch.
Catalog Version Required version of the catalog into which the batch must be ingested (e.g., '11').
Promote Catalog on Completion Boolean flag indicating whether the catalog should be promoted after the batch has been loaded.
Minimum Item Count Minimum number of items in the batch that must pass schema validation; ingestion fails if this threshold is not met.
Minimum Success Rate Percent Minimum percentage of items in the batch that must pass schema validation; ingestion fails if this threshold is not met.
Source Source identifier for items in the batch; relevant only when used with deleteMissingItems.
Delete Missing Items Boolean flag indicating whether items with the same source present in the catalog but missing in the batch should be deleted.
FHR Validation Boolean flag to enable Fredhopper (FHR) validation for the ingestion request.

Output

JSON

  • ingestionId - The unique identifier of the submitted batch ingestion.
  • status - The status of the batch ingestion request (e.g., pending, running, completed).
  • message - Informational message about the ingestion submission result.
  • catalogVersion - The catalog version associated with the ingestion.
  • promoteCatalogOnCompletion - Indicates if the catalog will be promoted after ingestion.

Dependencies

  • Fredhopper Product Discovery API access with credentials including tenant ID, username, password, and authentication URL.

Troubleshooting

  • Ensure the catalog version is provided; missing this will cause an error.
  • If an 'Invalid UUID string' error occurs, verify that the batchImportId is valid and that a batch exists for the specified catalog version.
  • Check that the tenant and environment parameters are correctly set and that the API credentials are valid.
  • Network or API errors should be handled by retrying or checking API availability.

Links

Discussion