avanta icon

avanta

Consume avanta API

Actions57

Download → Create Category

AI-generated

Overview

This node operation creates a new category in the Download resource of the Avanta API. It is useful for organizing downloadable content by categorizing it, which helps in managing and structuring files or documents within a store or system. For example, a user can create categories like 'Software', 'E-books', or 'Manuals' to better classify downloadable items.

Use Case Examples

  1. Creating a new category named 'Software' with active status for a specific store.
  2. Setting up hierarchical categories by specifying the level and tree path for nested categories.

Properties

Name Meaning
Request Options Options to configure the API request such as enabling debug mode, ignoring SSL issues, and setting request timeout.
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID, automatically read from webhook input if not set.
Store Name or ID The store identifier where the category will be created.
Status Indicates whether the category is active.
Title The title or name of the category.
Level The hierarchical level of the category.
Tree Path The path representing the category's position in the category tree.
Additional Fields Optional additional fields for the category such as parent category ID, external ID, and sort order.

Output

JSON

  • id - The unique identifier of the created category.
  • title - The title of the created category.
  • status - The active status of the created category.
  • level - The hierarchical level of the created category.
  • tree_path - The tree path representing the category's position.
  • parent_category_id - The ID of the parent category if set.
  • external_id - The external identifier of the category if provided.
  • order - The sort order of the category if specified.

Dependencies

  • An API key credential for authenticating with the Avanta API.

Troubleshooting

  • Ensure the store ID is valid and accessible to avoid errors related to store identification.
  • If using the bulk API, verify that the dataflow ID is correctly set or available from the webhook input to prevent processing failures.
  • Check SSL certificate settings if connection issues occur, especially when 'Ignore SSL Issues' is disabled.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Discussion