Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions20

Overview

This node interacts with the Fredhopper Product Discovery API to manage item schemas within a specified tenant and environment. Specifically, the "Get an Item Schema" operation retrieves the details of a particular item schema version by its name.

Common scenarios where this node is beneficial include:

  • Fetching the structure and metadata of an existing item schema for validation or inspection.
  • Automating workflows that require dynamic access to schema definitions before processing items.
  • Integrating schema retrieval into larger data pipelines for product catalog management.

For example, a user might use this node to programmatically obtain the JSON schema definition of a product item to ensure that incoming product data conforms to the expected format.

Properties

Name Meaning
Tenant The tenant identifier (e.g., "solutions") under which the item schema exists.
Environment The environment name (e.g., "cidp-test") specifying the deployment context of the schema.
FHR Validation A boolean flag indicating whether Fredhopper validation should be applied (not used here).
Schema Tenant The tenant under which the item schema is managed (usually same as Tenant).
Schema Environment The environment for the schema management (usually same as Environment).
Schema Name The name of the item schema to retrieve.
Schema Version The specific version of the item schema to fetch.

Output

The output is a JSON object representing the requested item schema's full details as returned by the Fredhopper Product Discovery API. This typically includes the schema's fields, types, constraints, and metadata describing the structure of items.

Example output structure (simplified):

{
  "name": "exampleSchema",
  "version": "1.0",
  "fields": [
    {
      "name": "productId",
      "type": "string",
      "required": true
    },
    {
      "name": "price",
      "type": "number",
      "required": false
    }
  ],
  "metadata": {
    "created": "2023-01-01T00:00:00Z",
    "updated": "2023-06-01T12:00:00Z"
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Fredhopper Product Discovery API.
  • The node uses OAuth2 client credentials flow to obtain an access token from the authentication URL provided in the credentials.
  • Network connectivity to the Fredhopper API endpoints (https://items.attraqt.io/item-schemas/...) is required.
  • No additional environment variables are needed beyond the configured API credentials.

Troubleshooting

  • Authentication failures: If the node throws an error about failing to obtain an access token, verify that the API credentials (username, password, auth URL) are correct and have sufficient permissions.
  • Schema not found: Errors may occur if the specified schema name or version does not exist. Double-check the spelling and version number.
  • Network errors: Ensure that the n8n instance has internet access and can reach the Fredhopper API endpoints.
  • Invalid JSON response: If the API returns malformed JSON, it could cause parsing errors. Check the API status or try again later.

Links and References

Discussion