avanta icon

avanta

Consume avanta API

Actions57

Category → Create or Update

AI-generated

Overview

This node handles the creation or updating of categories within the Avanta API. It is useful for workflows that need to manage category data dynamically, such as e-commerce platforms or content management systems that organize products or content into categories. For example, it can create a new category with specific attributes or update an existing category's details based on input data.

Use Case Examples

  1. Creating a new product category with a name, active status, and custom attributes.
  2. Updating an existing category's parent ID or URL key to reorganize category hierarchy.

Properties

Name Meaning
Request Options Options to customize the API request such as enabling debug mode, ignoring SSL issues, and setting request timeout.
Return to Webhook Whether to return the response to a webhook, requiring a subsequent 'Respond to Webhook' node.
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.
Name The name of the category to create or update.
Is Active Indicates if the category is active.
External ID External identifier mapping to Ecoplan CategoryInterface::getExternalId().
External Parent ID External parent identifier mapping to Ecoplan CategoryInterface::getExternalParentId().
ID The internal ID of the category.
Parent ID The internal ID of the parent category.
Additional Fields Additional optional fields such as URL key, menu inclusion, position, and custom attributes.

Output

JSON

  • id - The unique identifier of the created or updated category.
  • name - The name of the category.
  • is_active - Indicates if the category is active.
  • external_id - External identifier of the category.
  • external_parent_id - External parent identifier of the category.
  • parent_id - Internal parent category ID.
  • url_key - URL-friendly key for the category.
  • include_in_menu - Boolean indicating if the category is included in the menu.
  • position - Position of the category in listings.
  • customAttributes - Custom attributes associated with the category.

Dependencies

  • Avanta API key credential for authentication

Troubleshooting

  • Ensure all required fields like 'Name' and 'Is Active' are provided to avoid validation errors.
  • If using the bulk API, verify that the input data format matches the expected structure for bulk processing.
  • Enable Debug Mode to get detailed API request and response information for troubleshooting.
  • If SSL issues occur, consider enabling 'Ignore SSL Issues' option, but be aware of security risks.

Discussion