Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Overview

This node interacts with the Fredhopper Product Discovery API to manage item schemas within a specified tenant and environment. Specifically, the "Update an Item Schema" operation allows users to update an existing item schema by providing new schema data. This is useful in scenarios where the structure or validation rules of product items need to be modified to reflect changes in business requirements or data models.

Practical examples include:

  • Updating the attributes or fields of product items to support new features.
  • Modifying validation rules for product data ingestion.
  • Adjusting schema definitions to align with updated catalog structures.

Properties

Name Meaning
Tenant The tenant identifier under which the item schema exists (e.g., "solutions").
Environment The environment context for the schema (e.g., "cidp-test").
Schema Name The name of the item schema to update.
Schema Data The JSON string representing the new schema definition to apply.

Output

The output is a JSON object representing the response from the Fredhopper Product Discovery API after updating the item schema. It typically contains details about the updated schema, such as confirmation of the update, schema metadata, or any error messages if the update failed.

Example output structure (simplified):

{
  "name": "exampleSchema",
  "version": "1.2",
  "fields": [...],
  "updatedAt": "2024-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 before making API requests.
  • The API endpoint used for updating item schemas is https://items.attraqt.io/item-schemas/{schemaName} with query parameters for tenant and environment.
  • Proper configuration of tenant and environment values is necessary to target the correct schema.

Troubleshooting

  • Authentication errors: If the node fails to obtain an access token, verify that the API key credentials are correctly configured and have the necessary permissions.
  • Invalid schema data: Ensure that the Schema Data property contains valid JSON conforming to the expected schema format; otherwise, the API may reject the update.
  • Schema not found: If the specified schema name does not exist, the API will return an error. Confirm the schema name is correct.
  • Network issues: Check connectivity to the API endpoint and ensure no firewall or proxy blocks the request.
  • Error messages: The node throws errors with messages returned from the API or generic messages like "Failed to obtain access token" or "The operation 'updateItemSchema' is not supported!" if misconfigured.

Links and References

Discussion