Fredhopper Product Discovery icon

Fredhopper Product Discovery

Interact with Fredhopper Product Discovery API

Actions31

Item → Delete an Item Schema

AI-generated

Overview

This node operation deletes an item schema in the Fredhopper Product Discovery API. It is useful for managing and maintaining item schemas by removing outdated or unnecessary schemas from the system. For example, if a schema version is no longer needed or was created by mistake, this operation can be used to delete it.

Use Case Examples

  1. Deleting an obsolete item schema version to clean up the schema repository.
  2. Removing a test schema after validation is complete.

Properties

Name Meaning
schemaTenant The tenant under which the item schema exists, required to identify the schema context.
schemaEnvironment The environment (e.g., production, staging) where the schema is deployed, required for context.
schemaName The name of the item schema to delete, required to specify which schema to remove.
schemaVersion The version of the item schema to delete, required to specify the exact schema version to remove.

Output

JSON

  • deleted - Indicates whether the item schema was successfully deleted (true if deleted).

Dependencies

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

Troubleshooting

  • Common issues include authentication failures due to invalid or expired API credentials. Ensure the API key credential is valid and has the necessary permissions.
  • If the specified schema name or version does not exist, the API may return an error indicating the schema was not found. Verify the schema name and version are correct.
  • Network or connectivity issues may cause request failures. Check network access to the Fredhopper API endpoint.

Discussion