Actions31
- Authentication Actions
- Catalog Actions
- Category Tree Actions
- Item Actions
- Locale Actions
Item → Get an Item Schema
AI-generatedOverview
This node operation retrieves a specific item schema from the Fredhopper Product Discovery API. It is useful for scenarios where you need to fetch the structure and details of an item schema by specifying the schema name and version within a given tenant and environment. For example, it can be used to verify or inspect the schema before updating or using it in item data processing.
Use Case Examples
- Fetch the schema details of a product catalog item to validate its structure.
- Retrieve an item schema to ensure compatibility before importing or exporting item data.
Properties
| Name | Meaning |
|---|---|
| schemaTenant | The tenant identifier under which the item schema exists. |
| schemaEnvironment | The environment (e.g., production, staging) where the item schema is located. |
| schemaName | The name of the item schema to retrieve. |
| schemaVersion | The version of the item schema to retrieve. |
Output
JSON
schema- The JSON object representing the retrieved item schema details.
Dependencies
- Requires an API key credential for authentication with the Fredhopper Product Discovery API.
Troubleshooting
- Authentication errors may occur if the API credentials are invalid or expired. Ensure the API key credential is correctly configured.
- If the specified schema name or version does not exist, the node will throw an error indicating the schema could not be found.
- Network or connectivity issues may cause request failures; verify network access to the Fredhopper API endpoint.
Links
- Fredhopper Product Discovery API Documentation - Official documentation for the Fredhopper Product Discovery API, including item schema operations.